You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+15-14Lines changed: 15 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Please make sure you have checked all the following before submitting a new issu
20
20
- 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.
21
21
- Use the Bug & Feature Issue templates and provide all the required information.
22
22
- 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).
24
24
- Do not bump SnapX's version in conventional pull requests. Only release branches like `develop`, `alpha`, and `beta` can do that.
25
25
26
26
## Contributing Code
@@ -80,7 +80,8 @@ Each commit message consists of a **header**, a **body**, and a **footer**. The
80
80
></type>
81
81
```
82
82
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.
84
85
85
86
##### Type
86
87
@@ -99,8 +100,8 @@ Must be one of the following:
99
100
100
101
##### Scope
101
102
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.**
104
105
105
106
Examples
106
107
@@ -117,19 +118,19 @@ Examples
117
118
118
119
The subject contains a succinct description of the change:
119
120
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
123
124
124
125
##### Body
125
126
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.
127
128
128
129
##### Footer
129
130
130
131
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**.
131
132
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.
133
134
134
135
##### Sample Commit messages
135
136
@@ -193,23 +194,23 @@ The version bump is automatically determined based on your commit messages. Here
193
194
194
195
### Contribution Guidelines
195
196
196
-
- The `master` branch should always contain **stable and tested** code.
197
+
- The `master` branch should always contain **stable and tested** code.\
197
198
_Use Pull Requests for all features or bug fixes. Merge them only when ready._
198
199
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.\
200
201
_Avoid mixing multiple changes into a single commit._
201
202
202
-
- All commits must follow [Conventional Commit](https://www.conventionalcommits.org/) format.
203
+
- All commits must follow [Conventional Commit](https://www.conventionalcommits.org/) format.\
203
204
_We accept the Angular flavor (e.g., `feat:`, `fix:`) and support semantic bump hints._
204
205
205
206
### AI policy
206
207
207
208
Okay, so here's the thing:
208
209
209
-
-**No GitHub issues generated by AI.**
210
+
-**No GitHub issues generated by AI.**\
210
211
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.
211
212
212
-
-**No "vibe coding"**
213
+
-**No "vibe coding".**\
213
214
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.
214
215
215
216
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