Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 5223a1d

Browse files
committedMar 19, 2025
Tidy contribution guidelines
Fix GitHub markdown renderer issue with longer bullet entries. This commit explicitly separates the sentences with colon characters. Change-Id: I8bce9127b5056ef4458f5ddc5d8886e7747d6564
1 parent 64b9f90 commit 5223a1d

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed
 

Diff for: ‎CONTRIBUTING.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -801,38 +801,38 @@ We encourage every team to tailor these best practices to their specific needs w
801801
for a shared standard that promotes efficiency and code quality.
802802

803803
Below are the detailed guidelines that build on these principles.
804-
* Group Related Changes Together
804+
* Group Related Changes Together:
805805
Each commit should encapsulate a single, coherent change.
806806
e.g., if you are addressing two separate bugs, create two distinct commits.
807807
This approach produces focused, small commits that simplify understanding, enable quick rollbacks,
808808
and foster efficient peer reviews.
809809
By taking advantage of Git’s staging area and selective file staging,
810810
you can craft granular commits that make collaboration smoother and more transparent.
811-
* Commit Frequently
811+
* Commit Frequently:
812812
Making commits often ensures that your changes remain concise and logically grouped.
813813
Frequent commits not only help maintain a clean history but also allow you to share your progress with your teammates regularly.
814814
This regular sharing keeps everyone in sync,
815815
minimizes merge conflicts, and promotes a collaborative environment where integration happens seamlessly.
816-
* Avoid Committing Work in Progress
816+
* Avoid Committing Work in Progress:
817817
Only commit code when a logical component is in a stable, ready-to-integrate state.
818818
Break your feature's development into manageable segments that reach a functional milestone quickly,
819819
so you can commit regularly without compromising quality.
820820
If you feel the urge to commit merely to clear your working directory for actions like switching branches or pulling changes,
821821
use Git's stash feature instead.
822822
This practice helps maintain a stable repository and ensures that your team reviews well-tested, coherent code.
823-
* Test Your Code Before Committing
823+
* Test Your Code Before Committing:
824824
Before committing, ensure that your code has been thoroughly tested.
825825
Rather than assuming your changes are ready, run comprehensive tests to confirm they work as intended without unintended side effects.
826826
Testing is especially critical when sharing your code with others,
827827
as it maintains the overall stability of the project and builds trust among collaborators.
828-
* Utilize Branches for Parallel Development
828+
* Utilize Branches for Parallel Development:
829829
Branches are a powerful tool that enables developers to isolate different lines of work—whether you are developing new features,
830830
fixing bugs, or exploring innovative ideas.
831831
By using branches extensively, you can work on your tasks independently and merge only after careful review and testing.
832832
This not only keeps the main branch stable but also encourages collaborative code reviews and a more organized integration process.
833833

834834
Clear and descriptive commit messages are crucial for maintaining a transparent history of changes and for facilitating effective debugging and tracking.
835-
Please adhere to the guidelines outlined in [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).
835+
Please adhere to the guidelines outlined in [How to Write a Git Commit Message](https://cbea.ms/git-commit/).
836836
1. Separate the subject from the body with a blank line.
837837
2. Limit the subject line to 50 characters.
838838
3. Capitalize the subject line.

Diff for: ‎scripts/aspell-pws

+1
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,7 @@ regcomp
286286
regerror
287287
regexec
288288
regfree
289+
renderer
289290
retpoline
290291
reverseK
291292
rewind

0 commit comments

Comments
 (0)