Skip to content

Commit 240c289

Browse files
authored
docs: follow consistency (#408)
* make `CONTRIBUTING.md` have consistency and fix grammatical errors Signed-off-by: okcoder1 <codershub.code@gmail.com>
1 parent b95fc07 commit 240c289

1 file changed

Lines changed: 15 additions & 14 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Please make sure you have checked all the following before submitting a new issu
2020
- If you found an existing issue, use the react feature to show you have the same problem or need the same feature. Don't post comments like +1.
2121
- Use the Bug & Feature Issue templates and provide all the required information.
2222
- Be as detailed as possible and include screenshots wherever possible. This will help reproduce your bug or understand your feature request.
23-
- Refer to our [AI policy](#ai-policy)
23+
- Refer to our [AI policy](#ai-policy).
2424
- Do not bump SnapX's version in conventional pull requests. Only release branches like `develop`, `alpha`, and `beta` can do that.
2525

2626
## Contributing Code
@@ -80,7 +80,8 @@ Each commit message consists of a **header**, a **body**, and a **footer**. The
8080
></type>
8181
```
8282

83-
> Any line of the commit message cannot be longer than 100 characters!<br/> This allows the message to be easier to read on GitHub as well as in various Git tools.
83+
> Any line of the commit message cannot be longer than 100 characters! \
84+
> This allows the message to be easier to read on GitHub as well as in various Git tools.
8485
8586
##### Type
8687

@@ -99,8 +100,8 @@ Must be one of the following:
99100

100101
##### Scope
101102

102-
The scope could be anything that helps to specify the scope (or feature) that is changing.
103-
It is not required.
103+
The scope could be anything that helps to specify the scope (or feature) that is changing. \
104+
**It is not required.**
104105

105106
Examples
106107

@@ -117,19 +118,19 @@ Examples
117118

118119
The subject contains a succinct description of the change:
119120

120-
- use the imperative, present tense: "change" not "changed" nor "changes"
121-
- don't capitalize the first letter
122-
- no dot (.) at the end
121+
- Use the imperative, present tense: "change"; not "changed" nor "changes"
122+
- Don't capitalize the first letter
123+
- No dot (.) at the end
123124

124125
##### Body
125126

126-
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
127+
Just as in the **subject**, use the imperative, present tense: "change"; not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
127128

128129
##### Footer
129130

130131
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**, **Fixes**, or **Relates to**.
131132

132-
> Breaking Changes are intended to be highlighted in the ChangeLog as changes that will require community users to modify their code after updating to a version that contains this commit.
133+
> Breaking Changes are intended to be highlighted in the CHANGELOG as changes that will require community users to modify their code after updating to a version that contains this commit.
133134
134135
##### Sample Commit messages
135136

@@ -193,23 +194,23 @@ The version bump is automatically determined based on your commit messages. Here
193194
194195
### Contribution Guidelines
195196

196-
- The `master` branch should always contain **stable and tested** code.
197+
- The `master` branch should always contain **stable and tested** code. \
197198
_Use Pull Requests for all features or bug fixes. Merge them only when ready._
198199

199-
- Each bug fix, feature, or change should have **one commit** associated with it.
200+
- Each bug fix, feature, or change should have **one commit** associated with it. \
200201
_Avoid mixing multiple changes into a single commit._
201202

202-
- All commits must follow [Conventional Commit](https://www.conventionalcommits.org/) format.
203+
- All commits must follow [Conventional Commit](https://www.conventionalcommits.org/) format. \
203204
_We accept the Angular flavor (e.g., `feat:`, `fix:`) and support semantic bump hints._
204205

205206
### AI policy
206207

207208
Okay, so here's the thing:
208209

209-
- **No GitHub issues generated by AI.**
210+
- **No GitHub issues generated by AI.** \
210211
It won't be merged if it was written by a chatbot. Only open issues if you truly comprehend the feature or bug you're describing.
211212

212-
- **No "vibe coding"**
213+
- **No "vibe coding".** \
213214
Just because "it works on your machine" doesn't mean you should submit the code. It doesn't belong here if you can't explain what it does or why.
214215

215216
AI-assisted coding is acceptable. Copilots, linters, refactors, and other tools that speed up your work are all great as long as *you* understand what's happening behind the scenes.

0 commit comments

Comments
 (0)