Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/eladnoor/component-contribution/issues.
If you are reporting a bug, please follow the presented issue template since it is designed to ultimately make helping you easier and thus faster.
As any open source project, component-contribution could always use more and better documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles.
The best way to send feedback is to file an issue at https://github.com/eladnoor/component-contribution/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome ;)
Ready to contribute? Here's how to set up component-contribution for local
development.
Install git-lfs. On many linux distributions this can be installed from official package managers. 2. Fork the
component-contributionrepo on GitHub. 3. Clone your fork locally:git clone [email protected]:<your_name_here>/component-contribution.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature-branch
Now you can make your changes locally.
When you're done making changes, check that your changes pass the quality control:
tox
To get tox, just pip install it.
Commit your changes using semantic commit messages and push your branch to GitHub:
git add . git commit -m "feat: your detailed description of your changes" git push origin name-of-your-bugfix-or-feature
Submit a pull request to this repository through the GitHub website.