Skip to content

Commit 41526a6

Browse files
committed
formatting.
1 parent fdce9fa commit 41526a6

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

community/become-a-committer.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,42 +11,42 @@ High-Impact Contributions: Aim to contribute changes that significantly benefit
1111
## Engage in Code Reviews
1212
In open-source projects, reviewing others’ code is as important as submitting your own. Before becoming a committer, you should:
1313

14-
*Participate in Code Reviews:* Actively participate in code reviews by providing insightful feedback. Look for issues in logic, style, performance, and alignment with Slang’s objectives.
14+
**Participate in Code Reviews:** Actively participate in code reviews by providing insightful feedback. Look for issues in logic, style, performance, and alignment with Slang’s objectives.
1515

16-
*Help Raise the Code Quality:* Encourage adherence to Slang’s standards and practices by providing constructive feedback. The ability to review others’ code with a critical yet supportive approach is essential for committers.
16+
**Help Raise the Code Quality:** Encourage adherence to Slang’s standards and practices by providing constructive feedback. The ability to review others’ code with a critical yet supportive approach is essential for committers.
1717

1818
## Build Trust and Collaboration
1919
Committer status is granted based on the trust that you are deeply committed to Slang’s success. You can demonstrate this by:
2020

21-
*Being Reliable and Responsive:* Maintain a regular and responsive presence in the project, whether in pull requests, discussions, or reviews.
21+
**Being Reliable and Responsive:** Maintain a regular and responsive presence in the project, whether in pull requests, discussions, or reviews.
2222

23-
*Work Well with Others:* Slang is a community effort, so committers are expected to work well with other contributors, listen to feedback, and adapt where needed.
23+
**Work Well with Others:** Slang is a community effort, so committers are expected to work well with other contributors, listen to feedback, and adapt where needed.
2424

25-
*Take Ownership of Work:* Show a sense of responsibility by following up on contributions and addressing issues that arise in areas of the code you’ve worked on.
25+
**Take Ownership of Work:** Show a sense of responsibility by following up on contributions and addressing issues that arise in areas of the code you’ve worked on.
2626

2727
## Demonstrate Technical Understanding of Slang
2828
To maintain and develop the Slang codebase, committers need a comprehensive understanding of its internals. Demonstrate that you:
2929

30-
*Understand Slang’s Architecture:* Learn and follow Slang’s core architecture, coding patterns, and design principles.
30+
**Understand Slang’s Architecture:** Learn and follow Slang’s core architecture, coding patterns, and design principles.
3131

32-
*Know the Shading Language and Compiler Space:* Familiarize yourself with shading languages and compilers in general. This domain knowledge helps you contribute effectively and make informed decisions as a committer.
32+
**Know the Shading Language and Compiler Space:** Familiarize yourself with shading languages and compilers in general. This domain knowledge helps you contribute effectively and make informed decisions as a committer.
3333

3434
## Maintain a Record of High-Quality Contributions
3535
Consistent quality and dedication are key criteria. Committers typically have:
3636

37-
*A History of Reviewed Contributions:* Have at least 10 high-quality patches merged, with a record of thorough and constructive review feedback.
37+
**A History of Reviewed Contributions:** Have at least 10 high-quality patches merged, with a record of thorough and constructive review feedback.
3838

39-
*Positive Reviewer Feedback:* Accumulate reviews from existing committers that acknowledge your contribution quality and readiness.
39+
**Positive Reviewer Feedback:** Accumulate reviews from existing committers that acknowledge your contribution quality and readiness.
4040

4141
## The Committer Nomination Process
4242

4343
Once you meet the criteria above, you can nominate yourself to become a committer. This process includes:
4444

45-
*Nomination:* You can ask a committer to nominate you to become a committer via our discord channel.
45+
**Nomination:** You can ask a committer to nominate you to become a committer via our discord channel.
4646

47-
*Internal Review:* Existing committers will review your contributions, code review feedback, and responsiveness to determine your readiness.
47+
**Internal Review:** Existing committers will review your contributions, code review feedback, and responsiveness to determine your readiness.
4848

49-
*Final Approval:* Upon a positive consensus, you will be granted committer status along with write access to the Slang repository.
49+
**Final Approval:** Upon a positive consensus, you will be granted committer status along with write access to the Slang repository.
5050

5151
Becoming a committer is a meaningful responsibility, and we value contributors who are invested in maintaining and advancing Slang. Thank you for your continued contributions, and we look forward to welcoming you as a committer!
5252

community/code-quality.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,27 @@ Many graphics applications are having issues with long shader compilation times.
1313

1414
## Testing
1515

16-
*Unit and Integration Tests:* Include tests for all new features and bug fixes. Each pull request should add or update tests that validate the new functionality or fix. Pull requests should not break any existing tests.
16+
**Unit and Integration Tests:** Include tests for all new features and bug fixes. Each pull request should add or update tests that validate the new functionality or fix. Pull requests should not break any existing tests.
1717

18-
*Reproducibility:* Ensure that any reported bug fixes or features work consistently across different environments supported by Slang.
18+
**Reproducibility:** Ensure that any reported bug fixes or features work consistently across different environments supported by Slang.
1919

20-
*Maintain Test Coverage:* Maintain or improve existing test coverage. Avoid reducing the coverage or introducing untested paths in the code.
20+
**Maintain Test Coverage:** Maintain or improve existing test coverage. Avoid reducing the coverage or introducing untested paths in the code.
2121

2222
## Code Readability
2323

24-
*Readable and Self-Explanatory:* Code should be easy to read and self-explanatory, even without comments. Avoid overly complex or nested structures; prioritize clarity over conciseness.
24+
**Readable and Self-Explanatory:** Code should be easy to read and self-explanatory, even without comments. Avoid overly complex or nested structures; prioritize clarity over conciseness.
2525

26-
*Function and Variable Naming:* Use descriptive names for variables, functions, and classes. Names should make the code’s purpose immediately clear.
26+
**Function and Variable Naming:** Use descriptive names for variables, functions, and classes. Names should make the code’s purpose immediately clear.
2727

28-
*Comments:* Use comments to document the purpose of new types and functions you introduce. For functions that implement complex logic, comments should focus on why the logic is needed, and not just a rephrase of what the code is doing.
28+
**Comments:** Use comments to document the purpose of new types and functions you introduce. For functions that implement complex logic, comments should focus on why the logic is needed, and not just a rephrase of what the code is doing.
2929

30-
*Small, Focused Commits:* Keep each commit focused on a single change or issue. This helps reviewers understand the intent of the change and makes it easier to trace history later.
30+
**Small, Focused Commits:** Keep each commit focused on a single change or issue. This helps reviewers understand the intent of the change and makes it easier to trace history later.
3131

3232
## Code Review Process
3333

34-
*Follow Review Feedback:* Be prepared to make changes based on feedback from committers. We aim for constructive reviews that ensure quality without stalling progress.
34+
**Follow Review Feedback:** Be prepared to make changes based on feedback from committers. We aim for constructive reviews that ensure quality without stalling progress.
3535

36-
*Documentation and Clarity:* Provide a clear and detailed pull request description. Include context, goals, and any specific details reviewers should know to understand your contribution.
36+
**Documentation and Clarity:** Provide a clear and detailed pull request description. Include context, goals, and any specific details reviewers should know to understand your contribution.
3737

3838
## Community and Collaboration
3939
Be Respectful and Collaborative: Open-source projects are collaborative efforts. Communicate clearly, and respect feedback and the time of maintainers and reviewers.

0 commit comments

Comments
 (0)