Skip to content

Commit 2456c03

Browse files
authored
CONTRIBUTING: improve clarity
1 parent a46d104 commit 2456c03

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Given our limited resources, we do not review PRs that fail to adhere to this document.
3+
Given our limited resources, we may not review PRs that fail to adhere to this document.
44

55
Note that we have a [code of conduct](https://github.com/poac-dev/.github/blob/main/CODE_OF_CONDUCT.md),
66
follow it in all your interactions with the project.
@@ -109,11 +109,14 @@ mkdocs build --strict
109109
We generally follow the
110110
[Git Contribution Guidelines](https://git-scm.com/docs/SubmittingPatches#describe-changes).
111111

112-
- **First Line**: Ensure the first line of your commit message adheres to the
113-
guidelines for a concise and clear summary.
114-
- **Body**: While not mandatory, it is recommended to follow the rest of the
115-
guidelines to maintain consistency and provide helpful context for future
116-
readers.
112+
- **First Line**: `component: description of the patch` in all lowercase.
113+
- **Body**: Explain your change in 2-3 paragraphs:
114+
1. the current problem you want to solve
115+
2. justification of your change
116+
3. if any, alternative solutions considered but discarded
117+
118+
Read [Git Contribution Guidelines](https://git-scm.com/docs/SubmittingPatches#describe-changes)
119+
for more examples.
117120

118121
## Pull Request Style
119122

0 commit comments

Comments
 (0)