add contributing and releasing docs from base of repo (#113)

westerveltco · Aug 5, 2024 · 511e09d · 511e09d
1 parent 372617d
commit 511e09d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+### Added
+
+- Added both `CONTRIBUTING.md` and `RELEASING.md` files to official documentation.
+
 ### Changed
 
 - Added `allow-prereleases: true` to all Python setup steps in GitHub Actions workflows. This should allow for easy testing of future, unreleased versions of Python.

diff --git a/src/django_twc_package/docs/development/contributing.md b/src/django_twc_package/docs/development/contributing.md
@@ -0,0 +1,5 @@
+```{include} ../../CONTRIBUTING.md
+
+```
+
+See the [documentation](./just.md) for more information.
diff --git a/src/django_twc_package/docs/development/releasing.md b/src/django_twc_package/docs/development/releasing.md
@@ -0,0 +1,3 @@
+```{include} ../../RELEASING.md
+
+```
diff --git a/src/django_twc_package/docs/index.md b/src/django_twc_package/docs/index.md
@@ -7,5 +7,7 @@
 :maxdepth: 3
 :caption: Development
 
+development/contributing.md
 development/just.md
+Releasing <development/releasing.md>
 ```