Skip to content

Commit fcaf0a3

Browse files
intro: pr guide update in contributing page
1 parent ee660b8 commit fcaf0a3

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

docs/introduction/contributing.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,21 @@ Alternatively, reach out to Practicalli via the `#practicalli` channel of the Cl
3333

3434
## Considering a Pull request?
3535

36-
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.
36+
!!! INFO "Pull Request Commits must be cryptographically signed"
37+
All commits contributed to Practicalli must be signed via a legitimate SSH or GPG key to avoid the risk of commit spoofing.
3738

38-
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.
39+
[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}
3940

40-
All pull requests must include an entry in CHANGELOG.md or will not be merged. A changelog entry allows the community to easily follow the changes to the book.
41+
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.
4142

4243
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.
4344

44-
A PR with a list of changes across different sections will not be merged, it will be reviewed eventually though.
45+
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.
46+
47+
A PR with a list of changes across different sections will be closed without merging as these take considerable time to review.
48+
49+
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)
50+
4551

4652
## Thank you to everyone that has contributed
4753

0 commit comments

Comments
 (0)