Contributions are welcome!
Please carefully read this page to make the code review process go as smoothly as possible and to maximize the likelihood of your contribution being merged.
For bug reports or requests submit an issue.
The preferred way to contribute is to fork the main repository on GitHub.
Fork the main repository. Click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the GitHub server.
Clone this copy to your local disk:
$ git clone firstname.lastname@example.org:YourLogin/viz.git $ cd viz
Create a branch to hold your changes and start making changes. Don't work in the
$ git checkout -b my-feature
Work on this copy on your computer using Git to do the version control. When you're done editing, run the following to record your changes in Git:
$ git add modified_files $ git commit
Push your changes to GitHub with:
$ git push -u origin my-feature
Finally, go to the web page of your fork of the
vizrepo and click 'Pull Request' to send your changes for review.
GitHub Pull Requests Docs
If you are not familiar with pull requests, review the pull request docs.
Ensure your pull request satisfies all of the following, where applicable:
- Is covered by unit tests.
- Passes continuous integration.
- Is covered by documentation with comments and docstrings.
Review the following style guide.
Run code checks and fix any issues:
Refer to the Developer Installation section.