NOTE: this document has been adapted from the excellent Contributing
guide of the UofTCoders' rcourse.
The gds_env is an open-source project, aimed to provide a containerised platform for Geographic Data Science.
If you use the gds_env, we'd love to hear from you!
Here are a few pointers to effectively get in touch:
- If you find rough edges, you can open a new issue on the tracker
- If you would like to propose new libraries or extension, these are logged and compiled on issues with the "Stack changes" label. Check out the latest one and feel free to join the conversation
- If you use the
gds_env, we would love to hear about the context (education, research, industry) and how it goes. This is very rewarding in itself, but it also helps us map how the project is adopted and used, so don't be shy to reach out!
Anyone can contribute to the course repository via pull requests.
We use GitHub flow to manage changes:
- Create a fork of this repository, and clone it to your local computer.
- In your local copy of this repository, create a new branch.
- Commit your changes to that branch.
- Push the edits on that branch to your fork on GitHub.
- Submit a pull request to the main repository (
darribas/gds_env). - If you receive feedback on your pull request, make further commits to the new branch on your fork. These will automatically be added to your pull request.
You may wish to look at How to Contribute to an Open Source Project on GitHub for more detailed instructions. The GitHub Glossary is also a useful resource that explains Git-related terminology.