Skip to content

Commit 09b1daf

Browse files
intro: pr guide update in contributing page
1 parent ef1f237 commit 09b1daf

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

docs/introduction/contributing.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,20 @@ If something doesnt seem quite right or something is missing from the book, plea
2626

2727
## Considering a Pull request?
2828

29-
Before investing any time in a pull request, please raise an issue explaining the situation. This can save you and the maintainer time and avoid rejected pull requests.
29+
!!! INFO "Pull Request Commits must be cryptographically signed"
30+
All commits contributed to Practicalli must be signed via a legitimate SSH or GPG key to avoid the risk of commit spoofing.
31+
32+
[Configure commit signing with SSH key - Practicalli Engineering](https://practical.li/engineering-playbook/source-control/git-configuration/#commit-signing-with-ssh-key){target=_blank .md-button}
33+
34+
All pull requests must include an entry in CHANGELOG.md or will not be merged. A changelog entry allows the community to follow the changes to the book.
35+
36+
Each pull request will have a number of CI workflows run against the contribution, checking the format of the content and if a changelog entry has been provided.
3037

3138
Please keep pull requests small and focused, as they are much quicker to review and easier to accept. Ideally PR's should be for a specific page or at most a section.
3239

33-
A PR with a list of changes across different sections will not be merged, it will be reviewed eventually though.
40+
A PR with a list of changes across different sections will be closed without merging as these take considerable time to review.
41+
42+
Issues such as grammar improvements are typically a sign of a rushed section that requires a rewrite, so a pull request to fix a typeographic error will probably not be merged. Raise an issue, or post a thread in the [:globe_with_meridians: Clojurians Slack #practicall channel](https://clojurians.slack.com/messages/practicalli)
3443

3544
## Thank you to everyone that has contributed
3645

0 commit comments

Comments
 (0)