diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b76809660..ac5c25d08 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,9 @@ ----- - - - + + - [ ] The page (if new), does not already exist in the repo. - -- [ ] The page (if new), has been added to the correct platform folder: - `common/` if it's common to all platforms, `linux/` if it's Linux-specific, and so on. - +- [ ] The page is in the correct platform folder (`common/`, `linux/`, etc.) - [ ] The page has 8 or fewer examples. - -- [ ] The PR is appropriately titled: - `: add page` for new pages, or `: ` for pages being edited. - -- [ ] The page follows the [contributing](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md) guidelines. +- [ ] The PR title conforms to the recommended [templates](../blob/master/CONTRIBUTING.md#commit-message). +- [ ] The page follows the [content guidelines](../blob/master/CONTRIBUTING.md#guidelines). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2d386272..3d1291625 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,9 +87,10 @@ For the commit message, use the following format: : type of change Examples: - - `ls: add page` - - `cat: fix typo` - - `git-push: add --force example` + - For a new page addition: `ls: add page` + - For a page edit: `cat: fix typo`, `git-push: add --force example` + - For a new translation of an existing page: `cp: add Tamil translation` + - For related changes to several pages: `grep, find, locate: synchronize format of wildcards` ## Licensing