mirror of https://github.com/CrimsonTome/tldr.git
Update Contribution guidelines and PR template (#2575)
parent
f8c184402b
commit
c2fc8203ae
|
@ -1,19 +1,9 @@
|
||||||
----
|
|
||||||
<!-- Thank you for sending a PR! -->
|
<!-- Thank you for sending a PR! -->
|
||||||
<!-- Please perform the following checks and check all the boxes that apply. -->
|
<!-- Please perform the following checks and mark all the boxes accordingly. -->
|
||||||
<!-- If your PR does not create a command page,
|
<!-- You can remove the checklist items that don't apply to your PR. -->
|
||||||
you can remove the first two checklist items. -->
|
|
||||||
<!-- If your PR neither creates nor edits a command page (e.g. README edits, etc.)
|
|
||||||
you can simply remove the entire checklist. -->
|
|
||||||
|
|
||||||
- [ ] The page (if new), does not already exist in the repo.
|
- [ ] The page (if new), does not already exist in the repo.
|
||||||
|
- [ ] The page is in the correct platform folder (`common/`, `linux/`, etc.)
|
||||||
- [ ] 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 has 8 or fewer examples.
|
- [ ] The page has 8 or fewer examples.
|
||||||
|
- [ ] The PR title conforms to the recommended [templates](../blob/master/CONTRIBUTING.md#commit-message).
|
||||||
- [ ] The PR is appropriately titled:
|
- [ ] The page follows the [content guidelines](../blob/master/CONTRIBUTING.md#guidelines).
|
||||||
`<command name>: add page` for new pages, or `<command name>: <description of changes>` for pages being edited.
|
|
||||||
|
|
||||||
- [ ] The page follows the [contributing](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md) guidelines.
|
|
||||||
|
|
|
@ -87,9 +87,10 @@ For the commit message, use the following format:
|
||||||
<command>: type of change
|
<command>: type of change
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
- `ls: add page`
|
- For a new page addition: `ls: add page`
|
||||||
- `cat: fix typo`
|
- For a page edit: `cat: fix typo`, `git-push: add --force example`
|
||||||
- `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
|
## Licensing
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue