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
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,23 +29,25 @@ This is our recommended process. If it sounds too daunting, ask for help.
29
29
3. Create a branch in your fork with a descriptive name and put your fixes there. If your fix is
30
30
simple you could do it on github by editing a file, otherwise clone your project (or add a remote
31
31
to your current git clone) and work as usual.
32
-
4. If your change is important, add it to the release notesfor the upcoming version, [see](https://github.com/UCL/STIR/blob/master/documentation/)
32
+
4. Configure your editor and potentially even [pre-commit](https://pre-commit.com/), see
5. If your change is important, add it to the release notes for the upcoming version in the [documentation folder](https://github.com/UCL/STIR/tree/master/documentation/)
33
35
and even the [User's Guide](https://github.com/UCL/STIR/blob/master/documentation/STIR-UsersGuide.tex) or other documentation files.
34
-
5. Use [well-formed commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
36
+
6. Use [well-formed commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
35
37
for each change (in particular with a single "subject" line
36
-
followed by an empty line and then more details). If the change affects comments only, it is recommended to put `[ci skip]` in your subject line. This avoids unnecessary computation, and clogging our Travis/Appveyor queues.
37
-
6. Push the commits to your fork and submit a [pull request (PR)](https://help.github.com/articles/creating-a-pull-request)
38
-
(enable changes by project admins.) Give your pull request a descriptive name (i.e. don't call if *Fix #issuenumber*. Be prepared to add further commits to your branch after discussion.
39
-
In the description of the PR, add a statement about which Issue this applies to
40
-
using [a phrase such that github auto-closes the issue when merged to master](https://help.github.com/articles/closing-issues-using-keywords/).
41
-
7. Be prepared to add further commits to your branch after discussion.
38
+
followed by an empty line and then more details).
42
39
Please by mindful about the resources used by our Continuous Integration (CI) workflows:
43
40
- Group your commits and only push once your code compiles and tests succeed on your machine (ideally you have sensible commit messages at every stage)
44
41
- Use specific keywords in the first line of the last commit that you push to prevent CI being run:
45
42
-`[ci skip]` skips all CI runs (e.g. when you only change documentation, or when your update isn't ready yet)
46
43
-`[actions skip]` does not run GitHub Actions, see [here](https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/). Note: this can be in the main commit message.
47
44
-`[skip appveyor]` does not run Appveyor, see [here](https://www.appveyor.com/docs/how-to/filtering-commits/#skip-directive-in-commit-message)
48
-
8. After acceptance of your PR, go home with a nice warm feeling.
45
+
7. Push the commits to your fork and submit a [pull request (PR)](https://help.github.com/articles/creating-a-pull-request)
46
+
(enable changes by project admins.) Give your pull request a descriptive name (i.e. don't call if *Fix #issuenumber*. Be prepared to add further commits to your branch after discussion.
47
+
In the description of the PR, add a statement about which Issue this applies to
48
+
using [a phrase such that github auto-closes the issue when merged to master](https://help.github.com/articles/closing-issues-using-keywords/).
49
+
8. Be prepared to add further commits to your branch after discussion.
50
+
9. After acceptance of your PR, go home with a nice warm feeling.
49
51
50
52
Suggested reading:
51
53
https://help.github.com/articles/fork-a-repo/, https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project or https://guides.github.com/activities/forking/.
0 commit comments