Fix PR title guideline examples in CONTRIBUTING guidelines
James Mills committed
Jun 24, 2020 at 14:39 UTC
735880cd7e8140710ed7148cda1a4a628d6336f7
1 file changed
+5
-2
CONTRIBUTING.md
+5
-2
@@ -203,12 +203,15 @@ PR Descriptions:
203
Some PR title examples:
204
205
- Fix bug in Netdata installer for FreeBSD 11.2
206
-- Improve docs for other installation methods
207
-- New collector for Prometheus endpoints
206
+- Update docs for other installation methods
207
+- Add new collector for Prometheus endpoints
208
- Add 4.19 Kernel variant for eBPF
209
- Fix typo in README
210
+- Refactor code for better maintainability
211
- etc
212
213
+The key idea here is to start with a "verb" of what you are doing in the PR.
214
+
215
For good examples have a look at other projects like:
216
217
- https://github.com/facebook/react/commits/master