github/falco
1
0
Fork 0
mirror of https://github.com/falcosecurity/falco.git synced 2025-07-05 19:06:44 +00:00
Code Issues Projects Releases Wiki Activity

docs(CONTRIBUTING): commit convention details

Browse Source 
Signed-off-by: Lorenzo Fontana <lo@linux.com>
This commit is contained in:
Lorenzo Fontana 2019-12-04 12:27:45 +01:00 committed by Leo Di Donato
parent 418bcf2177
commit daca750cd9
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md
View File

@ -7,6 +7,8 @@
- [More about labels](#more-about-labels) - [More about labels](#more-about-labels)
- [Slack](#slack) - [Slack](#slack)
- [Pull Requests](#pull-requests) - [Pull Requests](#pull-requests)
- [Commit convention](#commit-convention)
- [`rule:` type](#rule-type)
- [Developer Certificate Of Origin](#developer-certificate-of-origin) - [Developer Certificate Of Origin](#developer-certificate-of-origin)
## Code of Conduct ## Code of Conduct
@ -96,6 +98,29 @@ Once your reviewer is happy, they will say `/lgtm` which will apply the
Your PR will be automatically merged once it has the `lgtm` and `approved` Your PR will be automatically merged once it has the `lgtm` and `approved`
labels, does not have any `do-not-merge/*` labels, and all status checks (eg., rebase, tests, DCO) are positive. labels, does not have any `do-not-merge/*` labels, and all status checks (eg., rebase, tests, DCO) are positive.
### Commit convention
As commit convention, we adopt [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/), we have an history
of commits that do not adopt the convention but any new commit must follow it to be eligible for merge.
#### `rule:` type
Besides the classic types, we adopt a type for rules, `rule(<scope>):`.
Example:
```
rule(Write below monitored dir): make sure monitored dirs are monitored.
```
Each rule change must be on its own commit, if a change to a macro is done while changing a rule they can go together but only one rule per commit must happen.
If you are changing only a macro, the commit will look like this:
```
rule(macro user_known_write_monitored_dir_conditions): make sure conditions are great
```
## Developer Certificate Of Origin ## Developer Certificate Of Origin
The [Developer Certificate of Origin (DCO)](https://developercertificate.org/) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. The [Developer Certificate of Origin (DCO)](https://developercertificate.org/) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.