-
Notifications
You must be signed in to change notification settings - Fork 110
Contributing Guide
Mithi Sevilla edited this page Jun 20, 2020
·
6 revisions
Thank you for your interest in contributing to this project! All types of contributions are welcome, no matter how big or small.
- Before contributing, please discuss the change you wish to make in an issue before making this change. Explain what you want to accomplish (e.g the problem you want to solve), why you want to do it, and how would do it. Wait for it to get assigned to you before working on a PR!
- First-time contributors are welcome! If you need clarification, don't hesitate to ask! There are no stupid questions! Your PR will not be merged if the CI build fails.
- Consistent code formatting is important. I use automated code formatters (prettier for Javascript, black for Python for example) to format my code.
- I use code climate to check for code smells.
- Please read the commit style guide, the guide which I try to adhere to when wording my commit messages. These are not rules, just a guide.
- I prefer PRs with fewer commits. Squash the commits and push force if you need to. But of course, it's better if all the changes in one commit are logically connected. For whatever purpose it may serve, here's a simple git workflow I try to stick to. Adding appropriate tests in your PR is always appreciated.
- Thoughtfully-written explanations and the rationale of the pull request is required! Explain what your PR is solving, why, and how. Allow project maintainers to edit your pull request.
- Of course, be a nice person :)
- Work on an existing issue (feature request, bug, etc)
- Add new tests and test cases to improve code coverage
- Work on optimizations, performance, speed, efficiency improvements
- Report and fix bugs
- Suggest idiomatic code and better software practices
- Suggest ways to improving code quality / readability
- Improve User Interface / Experience Design
- Improve documentation
- Your own cool idea! Feature requests. Suggest an idea for this project.
- More on: Types of Code Contributions