Closed JuliusWelzel closed 6 months ago
@rmndrs89 could you check the last part with setting up the local dev environment? Thanks
I have updated the local dev environment section accordingly.
Thanks, should we add it as a contributing.md to the docs?
Consider it done ;) should close this issue?
Yes, closing now as team decision 🚀 🔥 ✊
As we talked about, we should add a clear instruction on how to contribute to NGMT in the README and the docs as we actively want to support this. We can maybe follow some steps from this instructions. Imo the guide should read something like:
Contributing guide
Thanks for considering contributing to our toolbox! NGMT is an open-source project and we welcome contributions from anyone to further enhance this project
There are lots of ways to contribute, such as:
To report bugs, request new features, or ask about confusing documentation, it’s usually best to open a new issueon GitHub. For better reproducibility, be sure to include information about your operating system and NGMT version, and (if applicable) include a reproducible code sample that is as short as possible and ideally uses one of our example datasets.
Overview
In general you'll be working with three different copies of the the NGMT codebase: the official remote copy at https://github.com/neurogeriatricskiel/NGMT (usually called
upstream
), your remotefork
_ of the upstream repository (similar URL, but with your username in place ofNGMT
, and usually calledorigin
), and the local copy of the codebase on your computer. The typical contribution process is to:upstream
push
your changes toorigin
(your remote fork of the upstream)pull request
from your fork intoupstream
Setting up your local development environment
poetry install
.