Skip to content

Commit 90fe129

Browse files
authored
Merge pull request #85 from openearth/docs/contributions
update reference to the default branch
2 parents c2cffcf + f704e4d commit 90fe129

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -58,38 +58,35 @@ If you are a part of the AeoLiS team and have write access to the aeolis-python
5858

5959
1. Now, git remote -v will show two remote repositories named:
6060

61-
`upstream`, which refers to the aeolis-python repository <br>
62-
`origin`, which refers to your personal fork
63-
61+
* `upstream`, which refers to the aeolis-python repository
62+
* `origin`, which refers to your personal fork
6463

6564
### Develop your contribution
6665

67-
1. Create a branch off the latest commit on the AEOLIS_V2 branch to work on your feature.
66+
1. Create a branch off the latest commit on the `main` branch to work on your feature.
6867

6968
```bash
7069
git checkout -b my-feature
7170
```
7271

73-
1. If you are contributing via a fork, make sure to pull in changes from the 'upstream' repository to stay up to date with the AEOLIS_V2 branch while working on your feature branch. Follow the instructions [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork) and [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork).
72+
2. If you are contributing via a fork, make sure to pull in changes from the 'upstream' repository to stay up to date with the `main` branch while working on your feature branch. Follow the instructions [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork) and [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork).
7473

75-
1. Set up a development environment on your PC by installing the package in development mode with the following command: (Consider using a virtual environment for this purpose.)
74+
3. Set up a development environment on your computer by installing the AeoLiS in development mode with the following command: (Consider using a virtual environment for this purpose.)
7675

7776
```bash
7877
pip install -e .
7978
```
8079

81-
1. Set up your code editor to follow [PEP 8](https://peps.python.org/pep-0008/) (remove trailing white space, no tabs, etc.). Check code with [flake8](https://flake8.pycqa.org/en/latest/).
82-
83-
1. Write tests for any new lines of code you add.
80+
4. Set up your code editor to follow [PEP 8](https://peps.python.org/pep-0008/) (remove trailing white space, no tabs, etc.). Check code with [flake8](https://flake8.pycqa.org/en/latest/).
8481

85-
1. Include in-code documentation in form of comments and docstrings. Update the user documentation if relevant. Use the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) documentation style.
82+
5. Write tests for any new lines of code you add.
8683

84+
6. Include in-code documentation in form of comments and docstrings. Update the user documentation if relevant. Use the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) documentation style.
8785

8886
### Submitting your contribution
8987

90-
9188
1. Push your feature branch to (your fork of) the aeolis-python GitHub repository.
9289

93-
1. Create a pull request, for example, following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
90+
1. Create a pull request, for an example, following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
9491

95-
In case you feel you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.
92+
In case you feel you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation; don't let this discourage you from making the pull request. We can help you! Just go ahead and submit the pull request. But keep in mind that you might be asked to append additional commits to your pull request.

0 commit comments

Comments
 (0)