From 511e09d265938e894424d3844bc215edd84e195f Mon Sep 17 00:00:00 2001 From: Josh Thomas Date: Mon, 5 Aug 2024 13:10:37 -0400 Subject: [PATCH] add contributing and releasing docs from base of repo (#113) --- CHANGELOG.md | 4 ++++ src/django_twc_package/docs/development/contributing.md | 5 +++++ src/django_twc_package/docs/development/releasing.md | 3 +++ src/django_twc_package/docs/index.md | 2 ++ 4 files changed, 14 insertions(+) create mode 100644 src/django_twc_package/docs/development/contributing.md create mode 100644 src/django_twc_package/docs/development/releasing.md diff --git a/CHANGELOG.md b/CHANGELOG.md index ea879f1..c3d0058 100644 --- 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 new file mode 100644 index 0000000..661cb4c --- /dev/null +++ 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 new file mode 100644 index 0000000..652d72b --- /dev/null +++ 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 index 9385dba..28439ae 100644 --- 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 ```