Skip to content

Improve the contribution process with better checks and docs - #568

Merged
rytilahti merged 1 commit into
masterfrom
revisit_contributing
Oct 31, 2019
Merged

Improve the contribution process with better checks and docs#568
rytilahti merged 1 commit into
masterfrom
revisit_contributing

Conversation

@rytilahti

Copy link
Copy Markdown
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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants