Skip to content

Commit aae0bae

Browse files
toil(repo): repository settings update (#74)
## Description <!-- Describe your changes in detail --> - Several cosmetic adjustments to issue templates and main readme - Bigger update of the placeholder ROADMAP.md - Simplified PR template ## Type of Change <!-- Mark relevant items with an [x] --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update - [ ] Performance improvement - [ ] Code refactoring - [ ] Enterprise Edition feature - [ ] Test updates
1 parent 294c284 commit aae0bae

File tree

8 files changed

+84
-96
lines changed

8 files changed

+84
-96
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Bug report
1+
name: 🐛 Bug report
22
description: Create a report to help us improve
33
labels: ["bug"]
44

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Documentation
2+
name: 📚 Documentation Improvement
33
about: Report documentation issues or suggest improvements
44
title: '[DOCS] '
55
labels: documentation
@@ -33,5 +33,5 @@ assignees: ''
3333

3434
## Affects Version
3535
<!-- Which version(s) of the documentation does this affect? -->
36-
- [ ] Latest (main branch)
37-
- [ ] Previous versions (specify):
36+
- [ ] Cloud Semaphore
37+
- [ ] Community Edition (specify version):

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
name: 💡 Feature request
1+
name: 💡 Improvement proposal
22
description: Suggest a new idea/improvement for Semaphore
33
labels: ["enhancement"]
44
body:
55
- type: textarea
66
id: description
77
attributes:
8-
label: Is your feature request related to a problem? Please describe.
8+
label: Is your improvement proposal related to a problem? Please describe.
99
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1010
validations:
1111
required: true

.github/ISSUE_TEMPLATE/toil.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: 🛠️ Maintenance/Toil Task
3+
about: Track routine maintenance work or repetitive tasks
4+
title: '[TOIL] '
5+
labels: toil
6+
assignees: ''
7+
---
8+
9+
## Task Description
10+
<!-- Describe the maintenance or repetitive task that needs to be done -->
11+
12+
## Why This Is Needed
13+
<!-- Why is this maintenance important for the project? -->
14+
15+
## Improvement Ideas
16+
<!-- Any ideas on how this could be automated or improved? -->

.github/pull_request_template.md

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,11 @@
66
- [ ] Bug fix (non-breaking change which fixes an issue)
77
- [ ] New feature (non-breaking change which adds functionality)
88
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
9-
- [ ] Documentation update
9+
- [ ] Documentation/Repository docs update
1010
- [ ] Performance improvement
1111
- [ ] Code refactoring
12-
- [ ] Enterprise Edition feature
1312
- [ ] Test updates
1413

15-
## Impact
16-
<!-- Delete the non-applicable section -->
17-
### Community Edition Impact
18-
<!-- Describe the impact on CE users -->
19-
20-
### Enterprise Edition Impact
21-
<!-- Describe the impact on EE users -->
22-
2314
## Testing
2415
<!-- How has this been tested? -->
2516
- [ ] Unit tests added/updated
@@ -30,23 +21,9 @@
3021
## Documentation
3122
<!-- Mark relevant items with an [x] -->
3223
- [ ] Documentation update required
33-
- [ ] Documentation updated
34-
- [ ] No documentation changes needed
24+
- [ ] Changelog update required
3525

3626
## Related Issues
3727
<!-- Link related issues below. Insert the issue link or issue number -->
38-
- Closes <!-- insert issue link here -->
39-
- Related to <!-- insert issue link here -->
40-
41-
## Checklist
42-
<!-- Mark relevant items with an [x] -->
43-
- [ ] Code follows project style guidelines
44-
- [ ] Self review performed
45-
- [ ] Comments added to hard-to-understand areas
46-
- [ ] Tests prove change is effective
47-
- [ ] Relevant documentation updated
48-
- [ ] Changelog updated if needed
49-
- [ ] CI/CD changes required
50-
51-
## Additional Notes
52-
<!-- Add any additional notes for reviewers -->
28+
- Closes: <!-- insert issue link here -->
29+
- Related to: <!-- insert issue link here -->

GOVERNANCE.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Semaphore follows a governance model that balances commercial stewardship with c
8888

8989
- GitHub Issues and Discussions
9090
- [Project Documentation](https://docs.semaphoreci.com/CE/getting-started/about-semaphore)
91-
- [Discord Server](https://discord.com/channels/1097422014735732746/1097434200438755369)
91+
- [Discord Server](https://discord.gg/zEwewmzuft)
9292

9393
### Decision Visibility
9494

@@ -123,11 +123,3 @@ All participants must follow our [Code of Conduct](CODE_OF_CONDUCT.md).
123123
3. Maintainer review
124124
4. Project Owner approval
125125
5. Document update
126-
127-
## Project Resources
128-
129-
- [Contributing Guide](CONTRIBUTING.md)
130-
- [Support](SUPPORT.md)
131-
- [Security](SECURITY.md)
132-
- [Code of Conduct](CODE_OF_CONDUCT.md)
133-
- [Roadmap](ROADMAP.md)

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,4 @@ For now, please refer to:
101101

102102
🐦 **Follow us on Twitter**[@semaphoreci](https://twitter.com/semaphoreci)
103103

104+
▶️ **Watch our development meetings**[Semaphore Backstage](https://www.youtube.com/@SemaphoreBackstage)

ROADMAP.md

Lines changed: 56 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,101 @@
1-
# Project Roadmap
1+
# 🗺️ Project Roadmap
22

33
This document outlines the roadmap for Semaphore. While we strive to adhere to this roadmap, it may evolve based on community feedback and changing requirements.
44

5-
## Current Status (Q1 2025)
5+
## 🌟 SIG Roadmap
66

7-
### Community Edition
7+
### What does the Roadmap SIG do
8+
The Roadmap Special Interest Group works on:
9+
- 📋 Maintaining Issues, Discussions and RFCs to ensure proper documentation
10+
- 🔍 Conducting product and user research to provide context
11+
- 📣 Gathering feedback and requirements
12+
- ⚖️ Discussing, triaging, and prioritizing issues for monthly updates
813

9-
- Current stable version: X.Y.Z
10-
- Active development version: X.Y+1.Z
11-
- Supported versions: X.Y.Z, X.Y-1.Z
14+
### Key Info
15+
- 📅 **Meeting Frequency**: Monthly meetings, with more frequent meetups at end of each quarter
16+
- 💬 **Community Space**: [#sig-roadmap](https://discord.com/channels/1097422014735732746/1344321610861252659) Discord channel
17+
- ✍️ **Join Request**: [Fill in the form](https://forms.gle/tcNpGA4Zyghnu7sh8)
1218

13-
### Enterprise Edition
19+
## 📊 Current Status (Q1 2025)
1420

15-
Enterprise Edition is currently in development and will be released in Q3 2025.
21+
### 🌱 Community Edition
22+
- 🚀 **Current Stable Version**: [v1.0.0](https://github.com/semaphoreio/semaphore/releases/tag/v1.0.0)
23+
- 📆 **Scope for Q1 Monthly Updates**:
24+
- [March 2025](https://github.com/semaphoreio/semaphore/issues?q=is%3Aissue%20state%3Aopen%20milestone%3A%222025%20-%20March%22)
1625

17-
## Short-term Goals (Next 3-6 Months)
26+
### ☁️ Cloud Edition
27+
CD project kick-off is underway. Track the initial steps on [Semaphore Backstage YouTube channel](https://www.youtube.com/@SemaphoreBackstage). SIG will be opened by the end of Q1.
1828

19-
### Core Platform
29+
### 🏢 Enterprise Edition
30+
Enterprise Edition is currently in development and will be released in Q2 2025.
31+
32+
## 🔮 Short-term Goals (Next 3-6 Months)
2033

34+
### Core Platform
2135
- [ ] Reduced resource requirements for CE
22-
- [ ] Admin pannel interface
23-
- [ ] Quality of life improvements (TBD)
36+
- [ ] Admin panel interface
37+
- [ ] Quality of life improvements
2438

2539
### Developer Experience
26-
2740
- [ ] Streamlined local development setup
2841
- [ ] Developer documentation
2942
- [ ] Contribution guidelines improvements
3043

3144
### Integration & Extensibility
32-
33-
- [ ] New API roll out
3445
- [ ] Extended and improved list of starter templates
3546

36-
## Community Edition Priorities
47+
## 🌱 Community Edition Priorities
3748

3849
### Areas of Focus
50+
- 🧩 Quality of life improvements
51+
- 👩‍💻 Developer experience
52+
- 🛠️ Community tooling
53+
- 📚 Documentation improvements
3954

40-
- Core pipeline performance
41-
- Developer experience
42-
- Community tooling
43-
- Documentation improvements
44-
45-
## Enterprise Edition Focus
46-
47-
### Upcoming Features
55+
## 🏢 ☁️ Cloud and Enterprise Edition Focus
4856

49-
1. Supporting all the features available on SaaS - Q2 2025
50-
2. Releasing the v1.0 Enterprise Edition - Q3 2025
57+
### Ongoing Initiatives
58+
1. Kicking of the CD project - Q1 2025
59+
2. Supporting in EE all the features available on Cloud - Q2 2025
60+
3. Releasing the v1.0 Enterprise Edition - Q3 2025
5161

5262
### Priority Areas
63+
- Continuous Deployment projects (CD as a first class citizen)
64+
- Adding all the missing features to `ee/`
65+
- "Production ready" installation guidelines for `ee/`
5366

54-
- Advanced security features
55-
- Enterprise scaling
56-
- Compliance and reporting
57-
- Advanced management tools
58-
59-
## Contribution Opportunities
67+
## 👐 Contribution Opportunities
6068

6169
We welcome community contributions in these areas:
70+
- 📝 Documentation improvements
71+
- 🔧 [Help Wanted issues](https://github.com/semaphoreio/semaphore/labels/help%20wanted)
72+
- 🧪 Testing and quality assurance
73+
- ⚡ Performance optimizations
6274

63-
- Documentation improvements
64-
- [Help Wanted issues](https://github.com/semaphoreio/semaphore/labels/help%20wanted)
65-
- Testing and quality assurance
66-
- Performance optimizations
67-
68-
## Decision Making
75+
## 🤝 Decision Making
6976

7077
Roadmap decisions are made based on:
78+
- 💬 Community feedback
79+
- 🏢 Customer needs
80+
- 📈 Market trends
81+
- 💻 Technical requirements
82+
- 📊 Resource availability
7183

72-
- Community feedback
73-
- Customer needs
74-
- Market trends
75-
- Technical requirements
76-
- Resource availability
77-
78-
## Providing Feedback
84+
## 📢 Providing Feedback
7985

8086
We encourage feedback on our roadmap:
81-
8287
1. GitHub Discussions for general feedback
8388
2. Issue tracker for specific features
8489
3. Regular community meetings
8590
4. Direct communication for enterprise customers
8691

87-
## Updates & Changes
92+
## 🔄 Updates & Changes
8893

8994
This roadmap will be updated:
90-
91-
- Quarterly for major revisions
92-
- Monthly for status updates
93-
- As needed for significant changes
94-
95-
Last updated: [Date]
95+
- 🔄 Quarterly for major revisions
96+
- 📅 Monthly for status updates
97+
- ⚡ As needed for significant changes
9698

9799
---
98100

99-
Note: This roadmap is for informational purposes only and may change without notice based on business and community needs.
101+
*Note: This roadmap is for informational purposes only and may change without notice based on business and community needs.*

0 commit comments

Comments
 (0)