summaryrefslogtreecommitdiff
path: root/.github/how_to_use_github_to_contribute_to_gudhi.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/how_to_use_github_to_contribute_to_gudhi.md')
-rw-r--r--.github/how_to_use_github_to_contribute_to_gudhi.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/.github/how_to_use_github_to_contribute_to_gudhi.md b/.github/how_to_use_github_to_contribute_to_gudhi.md
index 0a6133b7..747ca39b 100644
--- a/.github/how_to_use_github_to_contribute_to_gudhi.md
+++ b/.github/how_to_use_github_to_contribute_to_gudhi.md
@@ -25,10 +25,10 @@ This creates a directory gudhi-devel, which you are free to move around or renam
cd gudhi-devel
```
-Everytime you clone the repository, you will have to download the *submodules*.
+When you clone the repository, you also need to download the *submodules*.
## Submodules
-An interface to Hera for Wasserstein distance is available on an external git repository. To download it:
+Hera, used for Wasserstein distance, is available on an external git repository. To download it:
```bash
git submodule update --init
```
@@ -60,8 +60,9 @@ This is a command you can run quite regularly.
It tells git to check all that happened on github.
It is safe, it will not mess with your files.
-**Reminder:** Everytime you checkout master or merge from master, afterwards, if the version of one the submodule has changed, or if a submodule was added, you will have to:
+**Reminder:** If the version of a submodule has changed, or if a submodule was added, you may need to:
```bash
+git submodule sync
git submodule update --init
```
@@ -90,6 +91,8 @@ Because of `-u`, it will remember where you like to push this branch, and next t
Possibly iterate a few times, add more commits and push them.
## Your pull request is ready
+Do not forget to update `.github/next_release.md` to announce your development in the next release note.
+
Get your web browser to https://github.com/LOGIN/gudhi-devel, click on the button that says **Branch: some-name** (below the number of commits, above the list of files) and select the branch you are so proud of.
Click on **New pull request** next to it.