Skip to content

Commit 66b95f5

Browse files
committed
docs: Restructure documentation with separate contributing section
1 parent e304d15 commit 66b95f5

File tree

5 files changed

+19
-0
lines changed

5 files changed

+19
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Creating a New Release
2+
======================
3+
4+
In principle, creating a release is nothing more than adding a version
5+
tag for a particular commit. In practice, we want to provide more:
6+
7+
1. Consistent and relevant documentation.
8+
2. A "blog" entry describing the release in approachable language.
9+
3. A "changelog" entry with detailed list of all changes.
10+
4. A new tag in the Read-The-Docs configuration.
11+
12+
Providing these requires more work up-front.

docs/develop/creating-new-release.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Creating a New Release
2+
======================
3+
4+
This document is used for the development of Cloe and documents
5+
the current process for creating a release.
6+
7+

0 commit comments

Comments
 (0)