update contrib guidelines to match new sections

Cog-Creators · Jul 16, 2019 · 8bd3f55 · 8bd3f55
1 parent 3b9327b
commit 8bd3f55
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 13 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -120,17 +120,20 @@ Whenever you pull from upstream (V3/develop on the main repository) and you noti
 
 Red uses towncrier to create changelogs
 
-To create a towncrier entry for your PR, create a file in `changelog.d` for it.
+To create a towncrier entry for your PR, create a file in `changelog.d` for it. If the changes are for a specific cog, place the file in the related subdirectory.
+
 The filename should be of the format `issuenumber.changetype.rst`
 
-You can create multiple entries if your PR fixes multiple things at once, but unless the fixes
-are strongly related, it is better to make multiple PRs
+You can create multiple entries if your PR should show up in multiple categories.
 
 Valid changetypes are:
 
+  * breaking : Breaking changes
+  * dep : Changes to dependencies
+  * enhance : Enhancements
   * feature : New features
   * bugfix : Bugfixes
-  * doc : documentation improvements and additions
+  * docs : documentation improvements and additions
   * removal : removal of something
   * misc : any changes which don't have a user facing change, and don't belong in the changelog for users.
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -90,17 +90,12 @@
         showcontent = true
 
     [[tool.towncrier.type]]
-        directory = "deprecation"
-        name = "Deprecations"
+        directory = "bugfix"
+        name = "Bug Fixes"
         showcontent = true
 
     [[tool.towncrier.type]]
-        directory = "fix"
-        name = "Fixes"
-        showcontent = true
-
-    [[tool.towncrier.type]]
-        directory = "enhancements"
+        directory = "enhance"
         name = "Enhancements"
         showcontent = true
 
@@ -120,6 +115,11 @@
         showcontent = false
 
     [[tool.towncrier.type]]
-        directory = "dependency"
+        directory = "dep"
         name = "Changes to dependencies"
         showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "docs"
+        name = "Documentation Changes"
+        showcontent = true