You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-13Lines changed: 10 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -58,38 +58,35 @@ If you are a part of the AeoLiS team and have write access to the aeolis-python
58
58
59
59
1. Now, git remote -v will show two remote repositories named:
60
60
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
64
63
65
64
### Develop your contribution
66
65
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.
68
67
69
68
```bash
70
69
git checkout -b my-feature
71
70
```
72
71
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).
74
73
75
-
1. Set up a development environment on your PC by installing the packagein 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 AeoLiSin development mode with the following command: (Consider using a virtual environment for this purpose.)
76
75
77
76
```bash
78
77
pip install -e .
79
78
```
80
79
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/).
84
81
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.
86
83
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.
87
85
88
86
### Submitting your contribution
89
87
90
-
91
88
1. Push your feature branch to (your fork of) the aeolis-python GitHub repository.
92
89
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, foran example, following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
94
91
95
-
In case you feel you've made a valuable contribution, but you don't know how to write or run tests forit, 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 keepin 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 forit, 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 keepin mind that you might be asked to append additional commits to your pull request.
0 commit comments