Document label meaning

Signed-off-by: Ludvig Liljenberg <[email protected]>

Author: ludfjig

.github/release.yml

@@ -5,30 +5,12 @@ changelog:
     labels:
       - chore
   categories:
-    - title: 🛠 Breaking Changes 
+    - title: 🎉 New Features or Improvements
       labels:
-        - breaking-change
-    - title: 🎉 New Features 
+        - kind/enhancement
+    - title: 🛠 Breaking Changes 
       labels:
-        - enhancement
+        - kind/breaking-change
     - title: 🐛 Bug Fixes
       labels:
-        - bug
-    - title: 🔒 Security Fixes
-      labels:
-        - security
-    - title: 🚀 Performance Improvements
-      labels:
-        - performance
-    - title: 👒 Dependencies
-      labels:
-        - dependencies
-    - title: 📚 Documentation
-      labels:
-        - documentation
-    - title: 🔬 Testing
-      labels:
-        - testing
-    - title: 📝 Other Changes
-      labels:
-        - "*"
+        - kind/bugfix

docs/github-labels.md

@@ -0,0 +1,34 @@
+# PRs
+
+To categorize PRs, we use Github labels. Before a PR can be merged, it is required that the PR is marked with one of the following 4 labels, because the PR label is used to generate automatic release-notes. The labels are as follows:
+
+- **kind/enhancement** - For PRs that add or improve *something*. 
+- **kind/breaking-change** - For PRs that change existing behavior.
+- **kind/bugfix** - For PRs that fix bugs.
+- **kind/ignore** - For any PRs not captured by the 3 categories above. Use this when the PR should not appear in the release notes.
+
+# Issues
+
+We categorize issues using the following 3 github types (not github labels):
+
+- **bug** - Unexpected problem or behavior
+- **enhancement** - Request, idea, or new functinonality
+- **design** - Relates to design of something
+
+To track lifetime of issues we also use Github labels:
+
+- **lifecycle/needs-review** - A temporary label to indicate that the issue has not yet been reviewed
+- **lifecycle/confirmed** - If the issue-type is **bug**, the bug has been confirmed. If the issue-type is **enhancement**, the new idea has been confirmed to be ready to be implemented. An issue that is not confirmed is usually closed.
+- **lifecycle/needs-info** - The issue is waiting for more info from OP
+
+
+# Issues & PRs
+
+In addition to the **kind/*** labels, we also have optional **area/*** labels to further narrow down which area a certain PR or issue is concerned about. These are purefly for categorization, not required, and not used for release notes. 
+
+- **area/testing** - PR/issue is related to tests or testing
+- **area/infrastructure** - PR/issue is related infrastructure, and not necessarily directly to core functionality
+- **area/documentation** - PR/issue is related to documentation
+- **area/performance** - PR/issue is related to performance
+- **area/security** - PR/issue is related to performance
+- **area/dependencies** PR/issue is related to dependencies