@@ -10,7 +10,7 @@ This guide explains how to set up your environment, make changes, and submit the
1010
1111## Getting Started
1212
13- Before contributing, please review the [ Developer Guide] ( ) .
13+ Before contributing, please review the [ Developer Guide] ( ) .
1414It covers REPO-NAME’s architecture, setup instructions, and contribution workflow.
1515
1616If you’re new to the project, we also recommend:
@@ -23,19 +23,19 @@ If you’re new to the project, we also recommend:
2323
2424When you’re ready to submit your work:
2525
26- 1 . ** Push your branch** to GitHub.
27- 2 . ** Open a [ pull request] ( https://help.github.com/articles/using-pull-requests/ ) ** against the ` main ` branch.
26+ 1 . ** Push your branch** to GitHub.
27+ 2 . ** Open a [ pull request] ( https://help.github.com/articles/using-pull-requests/ ) ** against the ` main ` branch.
28283 . ** Fill out the PR template** , including:
29- - A concise summary of what your PR does
30- - A list of all changes introduced
31- - Details on how these changes affect the repository (features, tests, documentation, etc.)
29+ - A concise summary of what your PR does
30+ - A list of all changes introduced
31+ - Details on how these changes affect the repository (features, tests, documentation, etc.)
32324 . ** Verify before submission** :
33- - All tests pass
34- - Pre-commit checks succeed
35- - Documentation is updated where applicable
33+ - All tests pass
34+ - Pre-commit checks succeed
35+ - Documentation is updated where applicable
36365 . ** Review process** :
37- - Your PR will be reviewed by the core development team.
38- - At least ** one approval** is required before merging.
37+ - Your PR will be reviewed by the core development team.
38+ - At least ** one approval** is required before merging.
3939
4040We aim to provide constructive feedback quickly and appreciate your patience during the review process.
4141
@@ -45,12 +45,12 @@ We aim to provide constructive feedback quickly and appreciate your patience dur
4545
4646Found a bug or have a feature request?
4747
48- 1 . ** Open a new issue** on GitHub.
49- 2 . Provide a ** clear and descriptive title** .
48+ 1 . ** Open a new issue** on GitHub.
49+ 2 . Provide a ** clear and descriptive title** .
50503 . Include:
51- - Steps to reproduce the issue (if applicable)
52- - Expected vs. actual behavior
53- - Relevant logs, screenshots, or input files
51+ - Steps to reproduce the issue (if applicable)
52+ - Expected vs. actual behavior
53+ - Relevant logs, screenshots, or input files
5454
5555Well-documented issues help us address problems faster and keep REPO-NAME stable and robust.
5656
0 commit comments