Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
When reporting a bug please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Feature requests and feedback
The best way to send feedback is to file an issue at https://github.com/seddonym/import-linter/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 code contributions are welcome :)
Submitting pull requests
Before spending time working on a pull request, we highly recommend filing a Github issue and engaging with the project maintainer (David Seddon) to align on the direction you’re planning to take. This can save a lot of your precious time!
This doesn’t apply to trivial pull requests such as spelling corrections.
For merging, you should:
Include passing tests (run
Update documentation when there’s new API, functionality etc.
Add a note to
CHANGELOG.rstabout the changes.
Add yourself to
To set up import-linter for local development:
Fork import-linter (look for the “Fork” button).
Clone your fork locally:
git clone email@example.com:your_name_here/import-linter.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, run all the checks with tox one command:
Commit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.