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
Fix GitHub markdown renderer issue with longer bullet entries.
This commit explicitly separates the sentences with colon characters.
Change-Id: I8bce9127b5056ef4458f5ddc5d8886e7747d6564
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -801,38 +801,38 @@ We encourage every team to tailor these best practices to their specific needs w
801
801
for a shared standard that promotes efficiency and code quality.
802
802
803
803
Below are the detailed guidelines that build on these principles.
804
-
* Group Related Changes Together
804
+
* Group Related Changes Together:
805
805
Each commit should encapsulate a single, coherent change.
806
806
e.g., if you are addressing two separate bugs, create two distinct commits.
807
807
This approach produces focused, small commits that simplify understanding, enable quick rollbacks,
808
808
and foster efficient peer reviews.
809
809
By taking advantage of Git’s staging area and selective file staging,
810
810
you can craft granular commits that make collaboration smoother and more transparent.
811
-
* Commit Frequently
811
+
* Commit Frequently:
812
812
Making commits often ensures that your changes remain concise and logically grouped.
813
813
Frequent commits not only help maintain a clean history but also allow you to share your progress with your teammates regularly.
814
814
This regular sharing keeps everyone in sync,
815
815
minimizes merge conflicts, and promotes a collaborative environment where integration happens seamlessly.
816
-
* Avoid Committing Work in Progress
816
+
* Avoid Committing Work in Progress:
817
817
Only commit code when a logical component is in a stable, ready-to-integrate state.
818
818
Break your feature's development into manageable segments that reach a functional milestone quickly,
819
819
so you can commit regularly without compromising quality.
820
820
If you feel the urge to commit merely to clear your working directory for actions like switching branches or pulling changes,
821
821
use Git's stash feature instead.
822
822
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:
824
824
Before committing, ensure that your code has been thoroughly tested.
825
825
Rather than assuming your changes are ready, run comprehensive tests to confirm they work as intended without unintended side effects.
826
826
Testing is especially critical when sharing your code with others,
827
827
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:
829
829
Branches are a powerful tool that enables developers to isolate different lines of work—whether you are developing new features,
830
830
fixing bugs, or exploring innovative ideas.
831
831
By using branches extensively, you can work on your tasks independently and merge only after careful review and testing.
832
832
This not only keeps the main branch stable but also encourages collaborative code reviews and a more organized integration process.
833
833
834
834
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/).
836
836
1. Separate the subject from the body with a blank line.
0 commit comments