Skip to content

Commit 0b47432

Browse files
bjorkertcodebymini
andauthored
Add commit guidelines to README (#568)
* Add commit guidelines and best practices to README.md * Add pull request guidelines to README --------- Co-authored-by: codebymini <daniel@codebymini.se>
1 parent cdac9d7 commit 0b47432

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,39 @@ Always rename your branch (that is aligned with `dev`) to a name suitable for yo
9292

9393
After a PR is merged to `dev`, there is an automatic bump up the version number - please do not modify the version in your branch.
9494

95+
### Pull Request Guidelines
96+
97+
Each pull request should focus on a **single concern** — one bug fix, one feature, or one improvement. Avoid combining unrelated changes in the same PR.
98+
99+
Focused PRs are easier to review, simpler to test, and safer to revert if needed. If your work touches multiple areas, consider splitting it into separate PRs that can be reviewed and merged independently.
100+
101+
### Commit Guidelines
102+
103+
Write commit messages that complete the sentence: **"If applied, this commit will..."**
104+
105+
For example:
106+
* "Add alarm snooze functionality" ✓
107+
* "Fix crash when loading empty profile" ✓
108+
* "Update documentation for build process" ✓
109+
* "Remove deprecated API calls" ✓
110+
111+
**Commit message structure:**
112+
113+
```
114+
<subject line - 50 chars or less>
115+
116+
<optional body - wrap at 72 chars>
117+
```
118+
119+
**Best practices:**
120+
* Use imperative mood in the subject line (Add, Fix, Update, Remove, Refactor)
121+
* Keep the subject line concise (50 characters or less)
122+
* Capitalize the first letter of the subject
123+
* Do not end the subject line with a period
124+
* Separate subject from body with a blank line
125+
* Use the body to explain *what* and *why*, not *how*
126+
* Reference related issues when applicable (e.g., "Fixes #123")
127+
95128
### Version Updates
96129

97130
Only the maintainers for LoopFollow will update version numbers.

0 commit comments

Comments
 (0)