Skip to content

Commit fe6ad3d

Browse files
committed
docs: Add development workflow to README
- Add Project Management section - Document issue tracking process - Describe project board columns - Add issue classification details
1 parent 97aed00 commit fe6ad3d

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,39 @@ Logs are stored in:
7777

7878
## Development
7979

80+
### Project Management
81+
82+
We use GitHub Projects to track the development of features and improvements. You can find our project board at:
83+
[Docker Safe Shutdown Development](https://github.com/users/PeterVinter/projects/1/views/1)
84+
85+
#### Development Workflow
86+
87+
1. **Issue Tracking**
88+
- All features and bugs are tracked as GitHub Issues
89+
- Features are versioned following semantic versioning:
90+
- v1.0.x: Bug fixes and minor improvements
91+
- v1.1.0: New features and functionality
92+
- v2.0.0: Breaking changes
93+
94+
2. **Project Board Columns**
95+
- 📋 Backlog: Planned features and improvements
96+
- 🎯 Priority: Selected for current development
97+
- 🏗️ In Progress: Currently being worked on
98+
- 👀 Review: Ready for code review
99+
- ✅ Done: Completed and merged
100+
101+
3. **Issue Classification**
102+
- Priority: 🔥 High, 🚀 Medium, 🌱 Low
103+
- Effort: 🐘 Large, 🦊 Medium, 🐇 Small
104+
- Target Version: Specified version for release
105+
- Assignees: Developer working on the issue
106+
107+
4. **Contributing**
108+
- Check the [Project Board](https://github.com/users/PeterVinter/projects/1/views/1) for available tasks
109+
- Read [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines
110+
- Follow the issue template when creating new issues
111+
- Reference issues in pull requests
112+
80113
### Automated Releases
81114

82115
This project uses GitHub Actions for automated releases. The workflow is triggered when a new tag is pushed and includes:

0 commit comments

Comments
 (0)