summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJames Mills <prologic@shortcircuit.net.au>2020-06-24 14:39:10 +1000
committerJames Mills <prologic@shortcircuit.net.au>2020-06-24 14:39:10 +1000
commit735880cd7e8140710ed7148cda1a4a628d6336f7 (patch)
tree570398be8a7e1cb045badbd6294338c7c7506e9a /CONTRIBUTING.md
parent28a447d56808ae195f63d2634c4eef50b7001e03 (diff)
Fix PR title guideline examples in CONTRIBUTING guidelines
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index eff450deab..441257d44c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -203,12 +203,15 @@ PR Descriptions:
Some PR title examples:
- Fix bug in Netdata installer for FreeBSD 11.2
-- Improve docs for other installation methods
-- New collector for Prometheus endpoints
+- Update docs for other installation methods
+- Add new collector for Prometheus endpoints
- Add 4.19 Kernel variant for eBPF
- Fix typo in README
+- Refactor code for better maintainability
- etc
+The key idea here is to start with a "verb" of what you are doing in the PR.
+
For good examples have a look at other projects like:
- https://github.com/facebook/react/commits/master