Skip to content

Commit e070ff6

Browse files
committed
docs: finalize contributing guide
1 parent 82fdaf5 commit e070ff6

2 files changed

Lines changed: 7 additions & 4 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,9 @@ Just as in the **subject**, use the imperative, present tense: "change"; not "ch
130130

131131
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**.
132132

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+
> Breaking Changes are intended to be highlighted in the CHANGELOG as MAJOR. The major version is increased IF:
134+
> - A release contains major UI/functionality updates (e.g., new interface design) that significantly change the user workflow.
135+
> - Breaking changes to the CLI (e.g., removing/renaming flags, changing output formats) that require users to update their scripts.
134136
135137
##### Sample Commit messages
136138

@@ -167,6 +169,7 @@ One of the major benefits of this approach is that it will **automatically relea
167169
- The master branch should always have working code that is tested. _Use Pull Requests to work on bigger features or bug fixes and merge them when you are ready._
168170
- Every bugfix, feature, and change should have one commit associated with it. _Do not mix multiple bugs, features, etc., into one huge commit message. Keep your commit size small and commit often._
169171
- Your commit messages must follow the [conventional commit rules](https://www.conventionalcommits.org/). Additionally, the Angular flavor is accepted as well.
172+
- While the version is v0.x.y, breaking changes will result in an increase of the Minor version. The Major version will remain 0 until the initial stable release (v1.0.0).
170173

171174
#### Versioning Rules
172175

@@ -208,7 +211,7 @@ The version bump is automatically determined based on your commit messages. Here
208211
Okay, so here's the thing:
209212

210213
- **No GitHub issues generated by AI.** \
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.
214+
It won't be reviewed if it was written by a chatbot. Only open issues if you truly comprehend the feature or bug you're describing.
212215

213216
- **No "vibe coding".** \
214217
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.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,12 @@ SnapX is packaged on:
9191

9292
Additionally, you can download nightly builds from [here](https://nightly.link/SnapXL/SnapX/workflows/build/develop?preview).
9393

94-
## Building & Contributions
94+
## Building & Contributing
9595

9696
Contributions are welcome.
9797
See [BUILDING.md](./.github/BUILDING.md) for build instructions.
9898

99-
The documentation for contributing is a work in progress, but here is a [rough draft](./.github/CONTRIBUTING.md).
99+
The documentation for contributing can be found [here](./.github/CONTRIBUTING.md).
100100

101101
## Donators 💖
102102

0 commit comments

Comments
 (0)