Contributions are always welcome and credit will 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.
The best way to send feedback is to file an issue at https://github.com/analyzere/analyzere-python-viz/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 review and implement.
To set up analyzere-python for local development:
Clone your fork locally:
git clone [email protected]:your_name_here/analyzere-python-viz.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 the test suite with tox:
tox
Commit your changes and push your branch to GitHub:
git add . git commit -m "Detailed description of your changes." git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
If you need some code review or feedback while you're developing the code, open a pull request and indicate that it is a work-in-progress.
For merging, you should:
- Include passing tests (run
tox
). - Add yourself to
AUTHORS
.