Skip to content

Commit 43d7536

Browse files
author
Adam Hughes
committed
docs: improve pull requests process documentation
1 parent 2d1836b commit 43d7536

File tree

1 file changed

+9
-18
lines changed

1 file changed

+9
-18
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,15 @@ all your interactions with the project members and users.
2626

2727
#### Process
2828

29-
1. Essential bug fix PRs should be sent to both master and release branches.
30-
2. Small bug fix and feature enhancement PRs should be sent to master only.
31-
3. Follow the existing code style precedent, especially for C. For Golang, you
32-
will mostly conform to the style and form enforced by the "go fmt" and
33-
"golint" tools for proper formatting.
34-
4. Ensure any install or build dependencies are removed before doing a build
35-
to test your PR locally.
36-
5. For any new functionality, please write appropriate go tests that will run
37-
as part of the Continuous Integration (Circle CI) system.
38-
6. The project's default copyright and header have been included in any new
39-
source files.
40-
7. Make sure you have implemented a local `make test` and all tests succeed
41-
before submitting the PR.
42-
8. Is the code human understandable? This can be accomplished via a clear code
43-
style as well as documentation and/or comments.
44-
9. The pull request will be reviewed by others, and finally merged when all
45-
requirements are met.
46-
10. Documentation must be provided if necessary (next section)
29+
1. Essential bug fix PRs should be sent to both `master` and release branches (if applicable).
30+
1. Small bug fix and feature enhancement PRs should be sent to `master` only.
31+
1. Follow the existing code style precedent. Use [golangci-lint](https://golangci-lint.run) to ensure your code is properly formatted and free of lint.
32+
1. For any new functionality, please write appropriate tests that will run as part of the continuous integration system ([CircleCI](https://circleci.com/gh/sylabs/workflows/sif)).
33+
1. Ensure the project's default copyright and header have been included in any new source files.
34+
1. Make sure you have run `go test ./...` and all tests succeed before submitting the PR.
35+
1. Is the code human understandable? This can be accomplished via a clear code style as well as documentation and/or comments.
36+
1. The pull request will be reviewed by others, and finally merged when all requirements are met.
37+
1. Documentation must be provided if necessary (next section)
4738

4839
#### Documentation
4940

0 commit comments

Comments
 (0)