Skip to content

Commit c2fc820

Browse files
waldyriousowenvoke
authored andcommitted
Update Contribution guidelines and PR template (#2575)
1 parent f8c1844 commit c2fc820

File tree

2 files changed

+9
-18
lines changed

2 files changed

+9
-18
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,9 @@
1-
----
21
<!-- Thank you for sending a PR! -->
3-
<!-- Please perform the following checks and check all the boxes that apply. -->
4-
<!-- If your PR does not create a command page,
5-
you can remove the first two checklist items. -->
6-
<!-- If your PR neither creates nor edits a command page (e.g. README edits, etc.)
7-
you can simply remove the entire checklist. -->
2+
<!-- Please perform the following checks and mark all the boxes accordingly. -->
3+
<!-- You can remove the checklist items that don't apply to your PR. -->
84

95
- [ ] The page (if new), does not already exist in the repo.
10-
11-
- [ ] The page (if new), has been added to the correct platform folder:
12-
`common/` if it's common to all platforms, `linux/` if it's Linux-specific, and so on.
13-
6+
- [ ] The page is in the correct platform folder (`common/`, `linux/`, etc.)
147
- [ ] The page has 8 or fewer examples.
15-
16-
- [ ] The PR is appropriately titled:
17-
`<command name>: add page` for new pages, or `<command name>: <description of changes>` for pages being edited.
18-
19-
- [ ] The page follows the [contributing](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md) guidelines.
8+
- [ ] The PR title conforms to the recommended [templates](../blob/master/CONTRIBUTING.md#commit-message).
9+
- [ ] The page follows the [content guidelines](../blob/master/CONTRIBUTING.md#guidelines).

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,10 @@ For the commit message, use the following format:
8787
<command>: type of change
8888

8989
Examples:
90-
- `ls: add page`
91-
- `cat: fix typo`
92-
- `git-push: add --force example`
90+
- For a new page addition: `ls: add page`
91+
- For a page edit: `cat: fix typo`, `git-push: add --force example`
92+
- For a new translation of an existing page: `cp: add Tamil translation`
93+
- For related changes to several pages: `grep, find, locate: synchronize format of wildcards`
9394

9495
## Licensing
9596

0 commit comments

Comments
 (0)