Skip to content

Commit 32d730a

Browse files
docs: include ci changes in CONTRIBUTING.md
Signed-off-by: Mirko von Leipzig <mirko.vonleipzig@gmail.com>
1 parent 6e38d3b commit 32d730a

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Before diving in to Interledger.rs, you may find it helpful to familiarize yours
3535
## Pull Requests
3636
We welcome pull requests (PRs) that address reported issues. You can find appropriate issues by `bug` or `help-wanted` labels. To avoid multiple PRs for a single issue, please let us know that you are working on it by a comment for the issue. Also we recommend to make discussions on the issue of how to address the issue, methodology towards the resolution or the architecture of your code, in order to avoid writing inefficient or inappropriate code.
3737

38-
Please follow the instruction below when making pull requests.
38+
Please follow the instruction below when making pull requests. These will be checked by our PR CI process where applicable, so don't worry about getting it wrong.
3939

4040
- Make sure that your branch is forked from the latest `master` branch.
4141
- Make sure that you wrote tests, ran it and the results were all green (required to pass CI).
@@ -47,17 +47,18 @@ Please follow the instruction below when making pull requests.
4747
- To install clippy, run `rustup component add clippy`.
4848
- To run clippy, use `cargo clippy --all-targets --all-features -- -D warnings`.
4949
- If you would like to make your local setup reject unformatted commits, you can add the command as a pre-commit hook in the file `interledger-rs/.git/hooks/pre-commit`.
50-
- Make sure to commit using `-s` or `--signoff` option like `git cz -s`.
50+
- Make sure to commit using `-s` or `--signoff` option like `git cz -s` (required to pass CI).
5151
- `cz` means using the [commitizen](https://github.com/commitizen/cz-cli) explained below.
5252
- Why we use the option is explained later in the [Signing-off](#Signing-off) section.
53-
- Make sure that you committed using the [commitizen](https://github.com/commitizen/cz-cli) format (commit messages should start with `feat:`, `docs:`, `refactor:`, `chore:`, etc). PRs may contain multiple commits but they should generally be squashed into one or a small number of complete change sets (for example, a feature followed by multiple refactors and another commit to add tests and docs should be combined into a single commit for that feature).
53+
- Make sure that you committed using the [commitizen](https://github.com/commitizen/cz-cli) format (commit messages should start with `feat:`, `docs:`, `refactor:`, `chore:`, etc) (required to pass CI). PRs may contain multiple commits but they should generally be squashed into one or a small number of complete change sets (for example, a feature followed by multiple refactors and another commit to add tests and docs should be combined into a single commit for that feature).
5454
- If you would like to make your local setup reject improperly formatted commit headers, you can add the following code to `interledger-rs/.git/hooks/commit-msg`:
5555
```bash
5656
if head -n 1 "$1" | grep -vqE "^(feat|fix|docs|style|refactor|perf|test|chore|ci|build)(\(.{1,30}\))?:[ ].{5,100}$"; then
5757
echo "Commit message rejected, commit aborted" && exit 1
5858
fi
5959
```
6060
- Make pull requests against `master` branch of this repository (interledger-rs/interledger-rs) from your repository.
61+
- The pull request should contain no merge commits (required to pass CI).
6162
- If reviewers request some changes, please follow the instruction or make discussions if you have any constructive opinions on the PRs you made.
6263
- Then if you want to make some changes on your PRs, `push -f` is allowed to renew your branch after squashing your new commits. You don't need to open new PRs.
6364
- For our [examples](../examples/README.md), we adopted a [literate programming](https://en.wikipedia.org/wiki/Literate_programming) approach. The examples are described in Markdown with shell commands included. The [`run-md.sh`](../scripts/run-md.sh) script parses the commands out of the Markdown file and runs them. If you want to add examples, please make sure your instruction file can be parsed and run by that script.

0 commit comments

Comments
 (0)