From fcaf0a388589e62c967dd8662a4b7e5a9d7c2bf6 Mon Sep 17 00:00:00 2001 From: Practicalli Engineering Date: Sun, 21 Jan 2024 22:56:41 +0000 Subject: [PATCH] intro: pr guide update in contributing page --- docs/introduction/contributing.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/introduction/contributing.md b/docs/introduction/contributing.md index 79ac1fccd..110b7d3b6 100644 --- a/docs/introduction/contributing.md +++ b/docs/introduction/contributing.md @@ -33,15 +33,21 @@ Alternatively, reach out to Practicalli via the `#practicalli` channel of the Cl ## Considering a Pull request? -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. +!!! INFO "Pull Request Commits must be cryptographically signed" + All commits contributed to Practicalli must be signed via a legitimate SSH or GPG key to avoid the risk of commit spoofing. -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. + [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} -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. +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. 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. -A PR with a list of changes across different sections will not be merged, it will be reviewed eventually though. +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. + +A PR with a list of changes across different sections will be closed without merging as these take considerable time to review. + +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) + ## Thank you to everyone that has contributed