Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Contribution Guidelines to Tornado Web Server #2675

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

nbmason14
Copy link

Per the issue listed here: #2668 I have taken a first pass at Contribution Guidelines for Tornado Web Server

If I am missing key information or need to make any edits please let me know and I will fix them

dxdrummer added 3 commits June 9, 2019 00:13
After reading through the repository I saw a request to add contribution guidelines so decided to create them.

This is one of my first contributions so I may be missing information, if so please let me know what I should add/edit to make this acceptable
@bdarnell
Copy link
Member

bdarnell commented Jun 9, 2019

This seems fine, but it's fairly generic. If this is all CONTRIBUTING.md is going to say, I'd rather just link to some generic contribute-to-open-source documentation. But instead, we should probably add some tornado-specific details:

  • We use black as a code formatter, and enforce this in CI.
  • We use type annotations and validate them with mypy.
  • Most pull requests should include new or updated tests to make sure the change works.
  • tox is the simplest way to run the tests locally. tox -e py37-full is recommended most of the time instead of running every configuration. tox -e py3-mypy,py3-lint checks formatting and type annotations.
  • We use sphinx's autodoc extension to extract docs from docstrings.
  • pip install -r maint/requirements.txt can be used to install the specific versions of tools like tox, sphinx, and linters used by Tornado developers.

@bdarnell bdarnell added the docs label Apr 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants