CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: information on new conventional commit format (#9573)

This commit is contained in:
Sebastian Spaink 2021-08-03 16:05:22 -05:00 committed by GitHub
parent 4928d5b30e
commit 8bf97809a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -5,6 +5,7 @@ show completion. -->
- [ ] Updated associated README.md. - [ ] Updated associated README.md.
- [ ] Wrote appropriate unit tests. - [ ] Wrote appropriate unit tests.
- [ ] Pull request title or commits are in [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/#summary) (e.g. feat: or fix:)
<!-- Link to issues that describe the need for the change. Issues <!-- Link to issues that describe the need for the change. Issues
should include context that will help reviewers understand why the should include context that will help reviewers understand why the

11
CONTRIBUTING.md
View File

@ -1,17 +1,20 @@
### Contributing ### Contributing
1. [Sign the CLA][cla]. 1. [Sign the CLA][cla].
1. Open a [new issue][] to discuss the changes you would like to make. This is 2. Open a [new issue][] to discuss the changes you would like to make. This is
not strictly required but it may help reduce the amount of rework you need not strictly required but it may help reduce the amount of rework you need
to do later. to do later.
1. Make changes or write plugin using the guidelines in the following 3. Make changes or write plugin using the guidelines in the following
documents: documents:
- [Input Plugins][inputs] - [Input Plugins][inputs]
- [Processor Plugins][processors] - [Processor Plugins][processors]
- [Aggregator Plugins][aggregators] - [Aggregator Plugins][aggregators]
- [Output Plugins][outputs] - [Output Plugins][outputs]
1. Ensure you have added proper unit tests and documentation. 4. Ensure you have added proper unit tests and documentation.
1. Open a new [pull request][]. 5. Open a new [pull request][].
6. The pull request title needs to follow [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/#summary)
**Note:** If you have a pull request with only one commit, then that commit needs to follow the conventional commit format or the `Semantic Pull Request` check will fail. This is because github will use the pull request title if there are multiple commits, but if there is only one commit it will use it instead.
#### Contributing an External Plugin *(new)* #### Contributing an External Plugin *(new)*