Updated hlog documentation to comply with GOLIB rules.
- Added comprehensive README.md with proper format and version number - Enhanced doc.go with complete godoc-compliant documentation - Updated RULES.md to clarify wiki home page requirement 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
2
RULES.md
2
RULES.md
@@ -24,6 +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
|
||||
|
||||
The wiki is located at ~/projects/golib-wiki and should be laid out as follows:
|
||||
- Link to wiki page from the Home page
|
||||
- Title and description with version number
|
||||
- Installation
|
||||
- Key Concepts and features
|
||||
@@ -40,5 +41,6 @@ The wiki is located at ~/projects/golib-wiki and should be laid out as follows:
|
||||
Any changes to existing features or additional features implemented should have tests created and/or updated
|
||||
|
||||
3. Version control
|
||||
Version numbers are specified using git tags.
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user