Skip to content

Commit

Permalink
intro: pull request signed commits and refactor pr guide
Browse files Browse the repository at this point in the history
  • Loading branch information
practicalli-johnny committed Jan 21, 2024
1 parent 94c1f7d commit 03a9e9d
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/introduction/contributing.md
Expand Up @@ -40,11 +40,18 @@ For small issues or if a discussion is required, post a message on [:globe_with_

## Considering a Pull request?

Before investing any time in a pull request, please raise a new 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.

[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 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.

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 not be merged, although it may be reviewed at some point with changes cherry picked.
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)

Expand Down

0 comments on commit 03a9e9d

Please sign in to comment.