Skip to content

Commit ba15434

Browse files
author
Lasim
committed
docs(all): update README links for better formatting
1 parent 44b2246 commit ba15434

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ We follow the Angular commit convention with **mandatory scoped messages**. This
8484
**Format:** `type(scope): subject`
8585

8686
**Mandatory Scopes:**
87+
8788
- `frontend`: Changes to the Vue.js frontend application
8889
- `backend`: Changes to the Fastify backend API
8990
- `gateway`: Changes to the DeployStack Gateway application
@@ -93,8 +94,9 @@ We follow the Angular commit convention with **mandatory scoped messages**. This
9394
- `deps`: Dependency updates
9495

9596
**Types:**
97+
9698
- `feat`: A new feature (minor version bump)
97-
- `fix`: A bug fix (patch version bump)
99+
- `fix`: A bug fix (patch version bump)
98100
- `docs`: Documentation changes
99101
- `style`: Changes that don't affect the code's meaning
100102
- `refactor`: Code changes that neither fix bugs nor add features
@@ -104,6 +106,7 @@ We follow the Angular commit convention with **mandatory scoped messages**. This
104106
- `chore`: Changes to the build process or tools
105107

106108
**Examples:**
109+
107110
- `feat(frontend): add dark mode support`
108111
- `fix(backend): resolve database connection timeout`
109112
- `feat(gateway): implement MCP server auto-discovery`
@@ -113,14 +116,17 @@ We follow the Angular commit convention with **mandatory scoped messages**. This
113116
- `ci(all): add automated security scanning`
114117

115118
**Why Scopes Matter:**
119+
116120
- **Automatic Changelog Generation**: Each service gets its own changelog with only relevant commits
117121
- **Independent Releases**: Frontend, backend, and gateway can be released independently
118122
- **Clear Impact**: Instantly see which part of the system is affected
119123

120124
**VS Code Integration:**
125+
121126
We've configured GitHub Copilot to automatically suggest scoped commit messages. Just click the sparkle ✨ button in the commit message box!
122127

123128
**Rules:**
129+
124130
1.**ALWAYS include a scope** - commits without scopes will not appear in service-specific changelogs
125131
2.**Use lowercase** for scopes and types
126132
3.**Keep subject under 72 characters**

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,11 @@
77
</p>
88

99
<p align="center">
10-
<a href="https://deploystack.io">🌐 Website</a>
11-
·
12-
<a href="https://docs.deploystack.io/">📚 Documentation</a>
13-
·
14-
<a href="https://deploystack.io/roadmap"><img src="./.assets/planner-icon.svg" width="12" height="12"/> Roadmap </a>
15-
·
16-
<a href="https://discord.gg/42Ce3S7b3b"><img src="./.assets/discord-icon.svg" width="12" height="12"/> Discord</a>
17-
</p>
10+
<a href="https://deploystack.io">🌐 Website</a> ·&nbsp;
11+
<a href="https://docs.deploystack.io/">📚 Documentation</a> ·&nbsp;
12+
<a href="https://deploystack.io/roadmap"><img src="./.assets/planner-icon.svg" alt="Roadmap" width="12" height="12"/> Roadmap </a> ·&nbsp;
13+
<a href="https://discord.gg/42Ce3S7b3b"><img src="./.assets/discord-icon.svg" alt="Discord" width="12" height="12"/> Discord</a>
14+
</p>
1815

1916
---
2017

0 commit comments

Comments
 (0)