Skip to content

Commit d3019de

Browse files
author
schmide
committed
adapt contribution steps
The starting point should be the develop branch. (cherry picked from commit 69caf56)
1 parent 7297472 commit d3019de

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,15 @@ Please see all CLIMADA's related scientific publications in our [repository of s
3333

3434
To contribute follow these steps:
3535

36-
1. Fork the project on GitHub (`git clone https://github.com/CLIMADA-project/climada_python.git`).
37-
2. Install the packages in `climada_python/requirements/env_climada.yml` and `climada_python/requirements/env_developer.yml`.
38-
3. Make well commented and clean commits to the repository. You can make a new branch here if you are modifying more than one part or feature.
39-
4. Make unit and integration tests on your code, preferably during development.
40-
5. Perform a static code analysis of your code with CLIMADA's configuration `.pylintrc`.
41-
6. Add your name to the AUTHORS file.
42-
7. Push the branch to GitHub (`git push origin my-new-feature`).
43-
8. On GitHub, create a new pull request from the feature branch.
36+
1. Fork the project on GitHub.
37+
2. Create a local clone of the develop branch (`git clone https://github.com/YOUR-USERNAME/climada_python.git -b develop`)
38+
3. Install the packages in `climada_python/requirements/env_climada.yml` and `climada_python/requirements/env_developer.yml`.
39+
4. Make well commented and clean commits to your repository.
40+
5. Make unit and integration tests on your code, preferably during development.
41+
6. Perform a static code analysis of your code with CLIMADA's configuration `.pylintrc`.
42+
7. Add your name to the AUTHORS file.
43+
8. Push the changes to GitHub (`git push origin develop`).
44+
9. On GitHub, create a new pull request onto the develop branch of CLIMADA-project/climada_python.
4445

4546
See our [contribution guidelines](https://climada-python.readthedocs.io/en/latest/guide/developer.html) for more information.
4647

0 commit comments

Comments
 (0)