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 17, 2023
1 parent 97ccd84 commit 6c3c5d8
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
5 changes: 4 additions & 1 deletion 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
43 changes: 43 additions & 0 deletions docs/src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,49 @@ 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)

### Testing your local changes

You can run local changes by simply running `m . <job>`.
If you're adding new files, make sure to `git add` them so Makes can recognize
them.

### Adding yourself to the mailmap

When contributing is important to add yourself to the
[.mailmap](https://github.com/fluidattacks/makes/blob/main/.mailmap) file.
Make sure to test it with `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.

Example:

```
This is my commit message
Signed-off-by: Robin Quintero <rohaquinlop301@gmail.com>
```

### Adding documentation

All added features must be commented in the same PR.
You can run `m . /docs/dev` to serve the [doc site](https://makes.fluidattacks.com)
on localhost.

### Other PR rules

A PR must:

- Only be one commit ahead of main.
- Have a title and body equal to its commmit message.

### 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, :ignore_code_blocks => true
rule 'MD018'
rule 'MD019'
rule 'MD020'
Expand Down

0 comments on commit 6c3c5d8

Please sign in to comment.