docs: Updating to reflect the move to Gitter
This commit is contained in:
Kurt Griffiths
John Vrbanac
parent
826febdce6
commit
60fa5f0327
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
All contributors and maintainers of this project are subject to this Code of Conduct.
|
||||
|
||||
We pledge to respect everyone who contributes to the *Falcon* project or other associated activities by (including but not limited to) creating project issues, submitting pull requests, and providing feedback on the same. We also pledge to respect everyone who participates in discussions on the project's mailing list, in the project's chat channel, in online discussion groups, and at meetups and conferences.
|
||||
We pledge to respect everyone who contributes to the *Falcon* project or other associated activities by (including but not limited to) creating project issues, submitting pull requests, and providing feedback on the same. We also pledge to respect everyone who participates in discussions both online and at meetups and conferences.
|
||||
|
||||
Unacceptable behavior includes (but is not limited to) offensive verbal comments related to gender, gender identity and expression, age, sexual orientation, disability, physical appearance, body size, race, ethnicity, religion, technology choices, sexual images in public spaces, deliberate intimidation, stalking, following, harassing photography or recording, sustained disruption of talks or other events, inappropriate physical contact, and unwelcome sexual attention.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,24 +5,18 @@ developers of all skill levels. To get started, simply fork the master branch
|
|||
on GitHub to your personal account and then clone the fork into your
|
||||
development environment.
|
||||
|
||||
Kurt Griffiths (**kgriffs** on IRC and Twitter) is the original creator of the
|
||||
Falcon framework, and currently co-maintains the project along with John Vrbanac (**jvrbanac** on IRC and Twitter). Falcon is developed by a growing
|
||||
community of users and contributors just like you.
|
||||
Kurt Griffiths (**kgriffs** on GH, Gitter, and Twitter) is the original
|
||||
creator of the Falcon framework, and currently co-maintains the project
|
||||
along with John Vrbanac (**jmvrbanac** on GH and Gitter, and
|
||||
**jvrbanac** on Twitter). Falcon is developed by a growing community of
|
||||
users and contributors just like you.
|
||||
|
||||
Please don't hesitate to reach out if you have any questions, or just need a
|
||||
little help getting started. You can find us in
|
||||
the [#falconframework][irc-channel] IRC channel on [Freenode][freenode]. It's the best way to discuss ideas, ask questions, and generally stay in touch with fellow contributors.
|
||||
[falconry/dev][gitter] on Gitter.
|
||||
|
||||
Please note that all contributors and maintainers of this project are subject to our [Code of Conduct][coc].
|
||||
|
||||
### Discussion Group
|
||||
|
||||
The Falcon community maintains a discussion group that you can use to
|
||||
share your ideas and ask questions about the framework. To join the
|
||||
discussion, please visit https://groups.google.com/d/forum/falconframework.
|
||||
|
||||
Per our [Code of Conduct][coc], we expect everyone who participates in community discussions to act professionally, and lead by example in encouraging constructive discussions. Each individual in the community is responsible for creating a positive, constructive, and productive culture.
|
||||
|
||||
### Pull Requests
|
||||
|
||||
Before submitting a pull request, please ensure you have added or updated tests as appropriate, and that all existing tests still pass with your changes on both Python 2 and Python 3. Please also ensure that your coding style follows PEP 8.
|
||||
|
|
@ -176,6 +170,6 @@ The footer should contain any information about **Breaking Changes** and is also
|
|||
[rtd]: https://falcon.readthedocs.io
|
||||
[coc]: https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md
|
||||
[freenode]: https://www.freenode.net/
|
||||
[irc-channel]: https://kiwiirc.com/client/irc.freenode.net/?#falconframework
|
||||
[gitter]: https://gitter.im/falconry/dev
|
||||
[ml-join]: mailto:users-join@mail.falconframework.org?subject=join
|
||||
[ml-archive]: https://mail.falconframework.org/archives/list/users@mail.falconframework.org/
|
||||
|
|
|
|||
17
README.rst
17
README.rst
|
|
@ -19,8 +19,8 @@ Quick Links
|
|||
-----------
|
||||
|
||||
* `Read the docs <https://falcon.readthedocs.io/en/stable>`__
|
||||
* `Join the discussion group <https://groups.google.com/forum/#!forum/falconframework>`__
|
||||
* `Hang out in #falconframework on freenode <https://kiwiirc.com/client/irc.freenode.net/?#falconframework>`__
|
||||
* `falconry/user <https://gitter.im/falconry/user>`__ @ Gitter
|
||||
* `falconry/dev <https://gitter.im/falconry/dev>`__ @ Gitter
|
||||
|
||||
How is Falcon different?
|
||||
------------------------
|
||||
|
|
@ -103,9 +103,11 @@ available for use in your projects. We've listed several of these on the
|
|||
`Falcon wiki <https://github.com/falconry/falcon/wiki>`_ as a starting
|
||||
point, but you may also wish to search PyPI for additional resources.
|
||||
|
||||
The Falcon community maintains a discussion group that you can use to
|
||||
share your ideas and ask questions about the framework. To join the
|
||||
discussion, please visit https://groups.google.com/d/forum/falconframework.
|
||||
The Falconry community on Gitter is a great place to ask questions and
|
||||
share your ideas. You can find us in `falconry/user
|
||||
<https://gitter.im/falconry/user>`_. We also have a
|
||||
`falconry/dev <https://gitter.im/falconry/dev>`_ room for discussing
|
||||
the design and development of the framework itself.
|
||||
|
||||
Per our
|
||||
`Code of Conduct <https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md>`_,
|
||||
|
|
@ -114,11 +116,6 @@ professionally, and lead by example in encouraging constructive
|
|||
discussions. Each individual in the community is responsible for
|
||||
creating a positive, constructive, and productive culture.
|
||||
|
||||
We also hang out in
|
||||
`#falconframework <https://kiwiirc.com/client/irc.freenode.net/?#falconframework>`_
|
||||
on freenode, where everyone is always welcome to ask questions and share
|
||||
ideas.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
|
|
|
|||
|
|
@ -8,16 +8,15 @@ developers of all skill levels. To get started, simply fork the master branch
|
|||
on GitHub to your personal account and then clone the fork into your
|
||||
development environment.
|
||||
|
||||
Kurt Griffiths (**kgriffs** on IRC and Twitter) is the original creator of the
|
||||
Falcon framework, and currently co-maintains the project along with John Vrbanac
|
||||
(**jvrbanac** on IRC and Twitter). Falcon is developed by a growing
|
||||
community of users and contributors just like you.
|
||||
Kurt Griffiths (**kgriffs** on GH, Gitter, and Twitter) is the original
|
||||
creator of the Falcon framework, and currently co-maintains the project
|
||||
along with John Vrbanac (**jmvrbanac** on GH and Gitter, and
|
||||
**jvrbanac** on Twitter). Falcon is developed by a growing community of
|
||||
users and contributors just like you.
|
||||
|
||||
Please don't hesitate to reach out if you have any questions, or just need a
|
||||
little help getting started. You can find us in
|
||||
`#falconframework <https://kiwiirc.com/client/irc.freenode.net/?#falconframework>`_
|
||||
on `Freenode <https://www.freenode.net/>`_. It's the best way to discuss ideas,
|
||||
ask questions, and generally stay in touch with fellow contributors.
|
||||
`falconry/dev <https://gitter.im/falconry/dev>`_ on Gitter.
|
||||
|
||||
Please check out our
|
||||
`Contributor's Guide <https://github.com/falconry/falcon/blob/master/CONTRIBUTING.md>`_
|
||||
|
|
|
|||
|
|
@ -9,18 +9,13 @@ to have you join us and share your ideas.
|
|||
|
||||
Please help us spread the word and grow the community!
|
||||
|
||||
IRC
|
||||
---
|
||||
Chat with fellow community members in the official Falcon IRC channel. It's a
|
||||
great place to ask questions and share your ideas. You can find us in
|
||||
`#falconframework <https://kiwiirc.com/client/irc.freenode.net/?#falconframework>`_
|
||||
on `Freenode <https://en.wikipedia.org/wiki/Freenode>`_.
|
||||
|
||||
Discussion Group
|
||||
----------------
|
||||
The Falcon community maintains a discussion group that you can use to
|
||||
share your ideas and ask questions about the framework. To join the
|
||||
discussion, please visit https://groups.google.com/d/forum/falconframework.
|
||||
Chat
|
||||
----
|
||||
The Falconry community on Gitter is a great place to ask questions and
|
||||
share your ideas. You can find us in `falconry/user
|
||||
<https://gitter.im/falconry/user>`_. We also have a
|
||||
`falconry/dev <https://gitter.im/falconry/dev>`_ room for discussing
|
||||
the design and development of the framework itself.
|
||||
|
||||
Per our
|
||||
`Code of Conduct <https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md>`_,
|
||||
|
|
@ -33,19 +28,21 @@ Submit Issues
|
|||
-------------
|
||||
If you have an idea for a feature, run into something that is harder to
|
||||
use than it should be, or find a bug, please let the crew know
|
||||
in **#falconframework** and/or by
|
||||
in `falconry/dev <https://gitter.im/falconry/dev>`_ or by
|
||||
`submitting an issue <https://github.com/racker/falcon/issues>`_. We
|
||||
need your help to make Falcon awesome!
|
||||
|
||||
Pay it Forward
|
||||
--------------
|
||||
We'd like to invite you to help other community members with their
|
||||
questions in IRC and on the mailing list, and to help peer-review
|
||||
questions in `falconry/user
|
||||
<https://gitter.im/falconry/user>`_, and to help peer-review
|
||||
`pull requests <https://github.com/racker/falcon/pulls>`_. If you use the
|
||||
Chrome browser, we recommend installing the
|
||||
`NotHub extension <http://nothub.org/>`_ to stay up to date with PRs. If you
|
||||
would like to contribute a new feature or fix a bug in the framework, please
|
||||
check out our
|
||||
`NotHub extension <http://nothub.org/>`_ to stay up to date with PRs.
|
||||
|
||||
If you would like to contribute a new feature or fix a bug in the
|
||||
framework, please check out our
|
||||
`Contributor's Guide <https://github.com/falconry/falcon/blob/master/CONTRIBUTING.md>`_
|
||||
for more information.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue