Improve contributing docs
nyxxxie opened this issue · 2 comments
nyxxxie commented
Make the current contributing.md into an overview of the development lifecycle for a feature, and point detailed stuff to docs in docs folder or more detailed sections. Also, determine if we want to actually use the issue tracker for non-bugs. Maybe, just use it for requests and use pull requests for features in development (check out how other people do it)
Life of a Feature
- Issue raised (person proposes an idea they want to see, possibly also implement)
- WIP Pull Request Opened, referencing issue
- Feature Developed, Tests Created, Pylinted, etc
- Feature Reviewed (tests run, pylint verified, merge-readiness confirmed)
- Feature Integrated, Issue Closed!
nyxxxie commented
Steal PR conventions from neovim, because their shtuff is RAD. https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md
nyxxxie commented
Steal some extra style shit from https://google.github.io/styleguide/pyguide.html
- Importing only modules is a dope idea
- Implicit false stuff is also dope
- Avoiding power features is DoOPPEEeee