Skip to content

Commit

Permalink
feat(build): fluidattacks#1108 document contributing
Browse files Browse the repository at this point in the history
Add new sections to the contributing.md file to help newcomers.

- Running your local changes
- Adding yourself to the mailmap
- Validating commit message
- DCO
- Adding and rendering documentation

Update lintMarkdown config.

Signed-off-by: Robin Quintero <rohaquinlop301@gmail.com>
  • Loading branch information
rohaquinlop committed Jun 16, 2023
1 parent 97ccd84 commit 25afdbb
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 3 deletions.
8 changes: 6 additions & 2 deletions docs/src/api/extensions/others.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ Example:
```bash
$ m . /example

{"score": {"base": 6.5, "temporal": 6.0, "environmental": 5.3}, "severity": {"base": "Medium", "temporal": "Medium", "environmental": "Medium"}}
{
"score": {"base": 6.5, "temporal": 6.0, "environmental": 5.3},
"severity": {"base": "Medium", "temporal": "Medium", "environmental": "Medium"}
}
```

## chunks
Expand Down Expand Up @@ -80,7 +83,8 @@ Example:
};
in
makeDerivationParallel {
dependencies = builtins.map buildNumber (inputs.nixpkgs.lib.lists.elemAt myChunks 0);
dependencies = builtins.map buildNumber (inputs.nixpkgs.lib.lists.elemAt
myChunks 0);
name = "build-numbers-0";
}
```
Expand Down
38 changes: 38 additions & 0 deletions docs/src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,44 @@ Examples:
- [feat(build): #252 aws secrets from env](https://github.com/fluidattacks/makes/commit/1c9f06a809bd92d56939d5809ce46058856fdf0a)
- [feat(build): #232 make parallel utils](https://github.com/fluidattacks/makes/commit/99e9f77482a6cbc9858a7a928a91a8a8aa9ff353)

### Running your local changes

Once you have finished your changes you need to add them to the staging area.
You should use `git add`, and add the files.

After that, just run `m . <job>` and if everything goes well you won't receive
any error message, if you do, then keep working, you're almost there!

### Adding yourself to the mailmap

When contributing is important to add yourself to the `.mailmap` file.
This file is lexicographically sorted, so you must to add you with this in mind.

You can test it running `m . /lintGitMailMap`.

### Validating commit message

Once you have your commit ready to be pushed, you can verify if your commit
have the proper structure with `m . /lintGitCommitMsg`.

### DCO

Contributors sign-off that they adhere to these requirements by adding a
`Signed-off-by` line to commit messages.

```
This is my commit message
Signed-off-by: Full Name <email>
```

Make sure that the commit's author matches with this information and the
`.mailmap` file information.

### Adding and rendering documentation

When contributing in documentation use `m . /docs/dev` to render it.

### The legal side of contributions

All of the code
Expand Down
2 changes: 1 addition & 1 deletion test/lint-markdown/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
rule 'MD010'
rule 'MD011'
rule 'MD012'
rule 'MD013', :tables => false, :code_blocks => false
rule 'MD013', :tables => false, :code_blocks => true
rule 'MD018'
rule 'MD019'
rule 'MD020'
Expand Down

0 comments on commit 25afdbb

Please sign in to comment.