doc(CONTRIBUTE): Reorganize contributing / community docs (#822)
De-duplicate content between RTD and CONTRIBUTING.md. Also update outdated information, including mailing list instructions.
This commit is contained in:
Kurt Griffiths
John Vrbanac
parent
cf3cb5029a
commit
a719168890
|
|
@ -1,8 +1,31 @@
|
|||
## Contributing
|
||||
## Contributer's Guide
|
||||
|
||||
Hi, thanks for your interest in the project! We welcome pull requests from 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.
|
||||
Thanks for your interest in the project! We welcome pull requests from
|
||||
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) is the creator and current maintainer of the Falcon framework, along with a group of talented and stylish volunteers. Please don't hesitate to reach out if you have any questions, or just need a little help getting started. You can find us on IRC in #falconframework on Freenode.
|
||||
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.
|
||||
|
||||
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 on [Freenode][freenode]. It's the best way to discuss ideas, ask
|
||||
questions, and generally stay in touch with fellow contributors.
|
||||
|
||||
Please note that all contributors and maintainers of this project are subject to our [Code of Conduct][coc].
|
||||
|
||||
### Mailing List
|
||||
|
||||
The Falcon community maintains a mailing list that you can use to share your ideas and ask questions about the framework. To join the list, simply send an email to [<users-join@mail.falconframework.org>][ml-join] (the subject and body will be ignored). You’ll receive a reply asking you to confirm the request.
|
||||
|
||||
Per our [Code of Conduct][coc], we expect everyone who participates on the mailing list 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.
|
||||
|
||||
[Discussions are archived][ml-archive] for future reference.
|
||||
|
||||
### 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 and doesn't cause pyflakes to complain.
|
||||
|
||||
|
|
@ -129,3 +152,7 @@ The footer should contain any information about **Breaking Changes** and is also
|
|||
[docstrings]: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html#example-google-style-python-docstrings
|
||||
[goog-style]: http://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments
|
||||
[rtd]: http://falcon.readthedocs.org
|
||||
[coc]: https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md
|
||||
[freenode]: https://www.freenode.net/
|
||||
[ml-join]: mailto:users-join@mail.falconframework.org?subject=join
|
||||
[ml-archive]: https://mail.falconframework.org/archives/list/users@mail.falconframework.org/
|
||||
|
|
|
|||
|
|
@ -1,42 +0,0 @@
|
|||
Mailing List
|
||||
------------
|
||||
The Falcon community maintains a mailing list that you can use to share
|
||||
your ideas and ask questions about the framework. We use the appropriately
|
||||
minimalistic `Librelist <http://librelist.com/>`_ to host the discussions.
|
||||
|
||||
To join the mailing list, simply send your first email to falcon@librelist.com!
|
||||
This will automatically subscribe you to the mailing list *and* sends your email
|
||||
along to the rest of the subscribers. For more information about managing your
|
||||
subscription, check out the
|
||||
`Librelist help page <http://librelist.com/help.html>`_.
|
||||
|
||||
All contributors and maintainers of this project are subject to our `Code
|
||||
of Conduct <https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md>`_.
|
||||
We expect everyone who participates on the mailing list 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.
|
||||
|
||||
`Discussions are archived <http://librelist.com/browser/falcon>`_
|
||||
for posterity.
|
||||
|
||||
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
|
||||
`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 to 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.
|
||||
|
||||
Code of Conduct
|
||||
---------------
|
||||
All contributors and maintainers of this project are subject to our `Code
|
||||
of Conduct <https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md>`_.
|
||||
|
|
@ -3,54 +3,24 @@
|
|||
Contribute to Falcon
|
||||
====================
|
||||
|
||||
`Kurt Griffiths <http://kgriffs.com>`_ is the creator and current
|
||||
maintainer of the Falcon framework. He works with a growing team of
|
||||
friendly and stylish volunteers like yourself, who review patches,
|
||||
implement features, fix bugs, and write docs for the project.
|
||||
Thanks for your interest in the project! We welcome pull requests from
|
||||
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.
|
||||
|
||||
Your ideas and patches are always welcome!
|
||||
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.
|
||||
|
||||
IRC
|
||||
---
|
||||
If you are interested in helping out, please join the **#falconframework**
|
||||
IRC channel on `Freenode <https://www.freenode.net/>`_.
|
||||
It's the best way to discuss ideas, ask questions, and generally stay
|
||||
in touch with fellow contributors. We recommend setting up a good
|
||||
IRC bouncer, such as ZNC, which can record and play back any conversations
|
||||
that happen when you are away.
|
||||
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 on `Freenode
|
||||
<https://www.freenode.net/>`_. It's the best way to discuss ideas, ask
|
||||
questions, and generally stay in touch with fellow contributors.
|
||||
|
||||
.. include:: contrib-snip.rst
|
||||
Please check out our
|
||||
`Contributor's Guide <https://github.com/falconry/falcon/blob/master/CONTRIBUTING.md>`_
|
||||
for more information.
|
||||
|
||||
Pull Requests
|
||||
-------------
|
||||
Before submitting a pull request, please ensure you have added new
|
||||
tests and updated existing ones as appropriate. We require 100%
|
||||
code coverage. Also, please ensure your coding style follows PEP 8 and
|
||||
doesn't make pyflakes sad.
|
||||
|
||||
**Additional Style Rules**
|
||||
|
||||
* Docstrings are required for classes, attributes, methods, and functions.
|
||||
* Use `napolean-flavored`_ docstrings to make them readable both when
|
||||
using the *help* function within a REPL, and when browsing
|
||||
them on *Read the Docs*.
|
||||
* Format non-trivial comments using your GitHub nick and an appropriate
|
||||
prefix. Here are some examples::
|
||||
|
||||
# TODO(riker): Damage report!
|
||||
# NOTE(riker): Well, that's certainly good to know.
|
||||
# PERF(riker): Travel time to the nearest starbase?
|
||||
# APPSEC(riker): In all trust, there is the possibility for betrayal.
|
||||
|
||||
* Commit messages should be formatted using `AngularJS conventions`_
|
||||
(one-liners are OK for now but bodies and footers may be required as the
|
||||
project matures).
|
||||
* When catching exceptions, name the variable ``ex``.
|
||||
* Use whitespace to separate logical blocks of code and to improve readability.
|
||||
* Do not use single-character variable names except for trivial indexes when
|
||||
looping, or in mathematical expressions implementing well-known formulae.
|
||||
* Heavily document code that is especially complex or clever!
|
||||
* When in doubt, optimize for readability.
|
||||
|
||||
.. _napolean-flavored: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html#example-google-style-python-docstrings
|
||||
.. _AngularJS conventions: http://goo.gl/QpbS7
|
||||
Thanks!
|
||||
|
|
|
|||
|
|
@ -11,10 +11,53 @@ Please help us spread the word and grow the community!
|
|||
|
||||
IRC
|
||||
---
|
||||
While you experiment with Falcon and work to familiarize yourself with
|
||||
the WSGI framework, please consider joining the **#falconframework**
|
||||
IRC channel on
|
||||
`Freenode <https://en.wikipedia.org/wiki/Freenode>`_. It's a great place to
|
||||
ask questions, share ideas, and get the scoop on what's new.
|
||||
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** on `Freenode <https://en.wikipedia.org/wiki/Freenode>`_.
|
||||
|
||||
Mailing List
|
||||
------------
|
||||
The Falcon community maintains a mailing list that you can use to share
|
||||
your ideas and ask questions about the framework. To join the list, simply send
|
||||
an email to
|
||||
`users-join@mail.falconframework.org <mailto:users-join@mail.falconframework.org?subject=join>`_
|
||||
(the subject and body will be ignored). You'll receive a reply asking you to
|
||||
confirm the request.
|
||||
|
||||
Per our
|
||||
`Code of Conduct <https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md>`_,
|
||||
we expect everyone who participates on the mailing list 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.
|
||||
|
||||
`Discussions are archived <https://mail.falconframework.org/archives/list/users@mail.falconframework.org/>`_
|
||||
for future reference.
|
||||
|
||||
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
|
||||
`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
|
||||
`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
|
||||
`Contributor's Guide <https://github.com/falconry/falcon/blob/master/CONTRIBUTING.md>`_
|
||||
for more information.
|
||||
|
||||
We'd love to have your help!
|
||||
|
||||
Code of Conduct
|
||||
---------------
|
||||
All contributors and maintainers of this project are subject to our `Code
|
||||
of Conduct <https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md>`_.
|
||||
|
||||
.. include:: contrib-snip.rst
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Loading…
Reference in New Issue