h/golib
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated RULES.md

Browse Source
This commit is contained in:
Haelnorr
2026-01-13 13:02:02 +11:00
parent 2a8c39002d
commit 7471ae881b
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
RULES.md
View File

@@ -8,7 +8,7 @@ Documentation is done in a few ways:
- wiki - wiki
The README for each module should be laid out as follows: The README for each module should be laid out as follows:
- Title and description - Title and description with version number
- Feature list (DO NOT USE EMOTICONS) - Feature list (DO NOT USE EMOTICONS)
- Installation (go get) - Installation (go get)
- Quick Start (brief example of setting up and using) - Quick Start (brief example of setting up and using)
@@ -24,7 +24,7 @@ Any Config structs with environment variables should have their docstrings match
where the required and default fields are only present if relevant to that variable where the required and default fields are only present if relevant to that variable
The wiki is located at ~/projects/golib-wiki and should be laid out as follows: The wiki is located at ~/projects/golib-wiki and should be laid out as follows:
- Title and description with version number (i will manually handle commits and versioning) - Title and description with version number
- Installation - Installation
- Key Concepts and features - Key Concepts and features
- Quick start - Quick start
@@ -39,5 +39,6 @@ The wiki is located at ~/projects/golib-wiki and should be laid out as follows:
2. All features should have tests. 2. All features should have tests.
Any changes to existing features or additional features implemented should have tests created and/or updated Any changes to existing features or additional features implemented should have tests created and/or updated
3. NEVER COMMIT 3. Version control
I will handle and manage all version control Do not change version numbers. When updating documentation, append the branch name to the version number.
Changes made to the golib-wiki repo should be made under the same branch name as the changes made in this repo