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.

Sign up for GitHub

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

Jump to bottom

Improve the contribution process with better checks and docs #568

Merged
merged 1 commit into from
Oct 31, 2019
Merged

Improve the contribution process with better checks and docs #568

merged 1 commit into from
Oct 31, 2019

Conversation

rytilahti
Copy link
Owner

After watching the pycon presentation by @hynek about maintainership [1], I had an urge to go and do something, namely:

  • Drop the links from README.rst to make rst-lint pass (not that they were that useful to begin with..), add the black badge
  • Add doc8 to pre-commit hooks to enforce that docs do not get broken
  • Improve the documentation on how to setup the development environment for potential contributors
  • Remove typing from tox.ini until the code follows the standard
  • Add lint environment for tox to allow easy execution of all the checks

[1] https://www.youtube.com/watch?v=9G2s1TN9QQY

@rytilahti
Improve the contribution process with better checks and docs
fb32b8e 
After watching the pycon presentation by @hynek about maintainership[1], I had an urge to go and do something, namely:

* Drop the links from README.rst to make rst-lint pass (not that they were that useful to begin with..), add the black badge
* Add doc8 to pre-commit hooks to enforce that docs do not get broken
* Improve the documentation on how to setup the development environment for potential contributors
* Remove typing from tox.ini until the code follows the standard
* Add lint environment for tox to allow easy execution of all the checks

[1] https://www.youtube.com/watch?v=9G2s1TN9QQY
@rytilahti rytilahti requested a review from syssi October 31, 2019 00:56
@rytilahti rytilahti merged commit 1f8b6cd into master Oct 31, 2019
@rytilahti rytilahti deleted the revisit_contributing branch October 31, 2019 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@syssi syssi syssi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rytilahti @syssi