Skip to content

Commit 4861ff0

Browse files
authored
docs: add automated changelog documentation (#7)
* feat: add automatic changelog update workflow Adds a GitHub Actions workflow that: - Triggers when PRs are merged to main - Automatically updates CHANGELOG.md - Creates a new PR with the changelog update - Determines change type from PR title - Increments version number automatically * docs: add automated changelog documentation Adds information about: - Automated CHANGELOG.md updates - Change type detection - Version increments - PR creation
1 parent 7f80076 commit 4861ff0

File tree

1 file changed

+7
-27
lines changed

1 file changed

+7
-27
lines changed

README.md

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -81,33 +81,13 @@ We use GitHub Projects to track the development of features and improvements. Yo
8181

8282
For detailed GitHub CLI commands and workflows, see our [GitHub CLI Workflow Guide](docs/github_cli_workflow.md).
8383

84-
#### Development Workflow
85-
86-
1. **Issue Tracking**
87-
- All features and bugs are tracked as GitHub Issues
88-
- Features are versioned following semantic versioning:
89-
- v1.0.x: Bug fixes and minor improvements
90-
- v1.1.0: New features and functionality
91-
- v2.0.0: Breaking changes
92-
93-
2. **Project Board Columns**
94-
- 📋 Backlog: Planned features and improvements
95-
- 🎯 Priority: Selected for current development
96-
- 🏗️ In Progress: Currently being worked on
97-
- 👀 Review: Ready for code review
98-
- ✅ Done: Completed and merged
99-
100-
3. **Issue Classification**
101-
- Priority: 🔥 High, 🚀 Medium, 🌱 Low
102-
- Effort: 🐘 Large, 🦊 Medium, 🐇 Small
103-
- Target Version: Specified version for release
104-
- Assignees: Developer working on the issue
105-
106-
4. **Contributing**
107-
- Check the [Project Board](https://github.com/PeterVinter/Manage_linux_docker_containers/projects) for available tasks
108-
- Read [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines
109-
- Follow the issue template when creating new issues
110-
- [Create a new issue](https://github.com/PeterVinter/Manage_linux_docker_containers/issues/new) to report bugs or suggest features
84+
### Automated Changelog
85+
86+
This project uses an automated changelog workflow that:
87+
- Updates CHANGELOG.md when PRs are merged to main
88+
- Determines change type from PR title (feat, fix, docs, etc.)
89+
- Increments version number automatically
90+
- Creates a new PR with changelog updates
11191

11292
### Automated Releases
11393

0 commit comments

Comments
 (0)