From f704e4d8d5c09a05f0b216d03df7fc3730c37eaa Mon Sep 17 00:00:00 2001 From: "Manuel G. Garcia" Date: Wed, 1 Mar 2023 09:07:45 +0100 Subject: [PATCH] update reference to the default branch --- CONTRIBUTING.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5ce01d4..f1414441 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,38 +58,35 @@ If you are a part of the AeoLiS team and have write access to the aeolis-python 1. Now, git remote -v will show two remote repositories named: - `upstream`, which refers to the aeolis-python repository
- `origin`, which refers to your personal fork - + * `upstream`, which refers to the aeolis-python repository + * `origin`, which refers to your personal fork ### Develop your contribution -1. Create a branch off the latest commit on the AEOLIS_V2 branch to work on your feature. +1. Create a branch off the latest commit on the `main` branch to work on your feature. ```bash git checkout -b my-feature ``` -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). +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). -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.) +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.) ```bash pip install -e . ``` -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/). - -1. Write tests for any new lines of code you add. +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/). -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. +5. Write tests for any new lines of code you add. +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. ### Submitting your contribution - 1. Push your feature branch to (your fork of) the aeolis-python GitHub repository. -1. Create a pull request, for example, following the instructions [here](https://help.github.com/articles/creating-a-pull-request/). +1. Create a pull request, for an example, following the instructions [here](https://help.github.com/articles/creating-a-pull-request/). -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. \ No newline at end of file +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.