Skip to content

Commit 66aee45

Browse files
authored
Enhance contributing guidelines
1. New rules: Include a summarized version of the rule proposal template, explaining what's required and why, and include good/bad examples. 2. PR requirements: PRs should also update documentation as needed and reference an existing or new issue 3. Branch naming: All PRs should have a branch name that reflects the issue type, number, and a short description. For example, `feature/123-new-rule-description` or `bug/456-fix-typo`. Signed-off-by: Eve Coull <coolssor@oe.tc>
1 parent 578e4e5 commit 66aee45

1 file changed

Lines changed: 25 additions & 4 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
11
# Contributing
22

3-
If you'd like to contribute to Doclint, please follow these steps:
3+
Thanks for thinking about contributing to Doclint! We have a few guidelines to make sure contributions meet the bar for quality and consistency.
44

5-
1. **Fork the repository**: Create a personal copy of the repository on GitHub.
6-
2. **Make changes**: Implement your changes in your forked repository.
7-
3. **Submit a pull request**: Propose your changes to the original repository by submitting a pull request.
5+
## New rules
6+
7+
If you want to propose a new rule, please create a new issue using the "Rule proposal" template. This'll help us understand your idea better, and ensure it aligns with the project's goals.
8+
9+
When filling out the template, please provide as much detail as possible, including:
10+
11+
- A description of the new rule in one or two sentences
12+
- An explanation of what issue it'll fix
13+
- Examples of writing before and after the rule is applied
14+
- If possible, some example of where this rule fixed the issue described above
15+
- Good examples include techniques from the W3C, or examples from well-known style guides
16+
- Bad examples include personal opinions or anecdotal evidence
17+
18+
## Pull requests
19+
20+
If you're ready to implement a new rule or fix an existing issue, please open a pull request. Make sure to:
21+
22+
- Update the documentation as needed
23+
- Reference the issue your pull request fixes
24+
- All pull requests should be linked to an issue, even if it's just a minor fix. This makes separating general discussion from development easier.
25+
26+
Pull requests will be reviewed by the maintainers, and we might request changes or provide feedback. Please be patient, as we want to ensure all contributions meet our quality standards.
27+
28+
**Note to maintainers:** All pull requests should have a branch name that reflects the issue type, number, and a short description. For example, `feature/123-new-rule-description` or `bug/456-fix-typo`.

0 commit comments

Comments
 (0)