mirror of
https://github.com/tldr-pages/tldr.git
synced 2024-08-16 15:30:24 +03:00
CONTRIBUTING: use and instead of / when mentioning commit messages and PR titles
This commit is contained in:
parent
c4fcb8bf47
commit
4e7c465342
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -8,5 +8,5 @@ See also https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md
|
||||
- [ ] The page(s) have at most 8 examples.
|
||||
- [ ] The page description(s) have links to documentation or a homepage.
|
||||
- [ ] The page(s) follow the [content guidelines](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#guidelines).
|
||||
- [ ] The PR title conforms to the recommended [templates](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#commit-messagepr-title).
|
||||
- [ ] The PR title conforms to the recommended [templates](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#commit-message-and-pr-title).
|
||||
- **Version of the command being documented (if known):**
|
||||
|
@ -224,7 +224,7 @@ To commit a suggestion to your pull request, click on `Commit suggestion`:
|
||||
|
||||
If you want to commit multiple suggestions, go to the "Files changed" tab and batch all suggestions. Now, click the `Commit suggestions` button and enter a commit message to create a single commit.
|
||||
|
||||
### Commit message/PR title
|
||||
### Commit message and PR title
|
||||
|
||||
For the commit message and PR title of page changes, use the following format:
|
||||
|
||||
@ -241,7 +241,7 @@ Where `{{command}}` is the name of the command being modified, and `type of chan
|
||||
- For multiple subcommand page additions: `git-{add, push, ...}: add page`
|
||||
- For modifying multiple pages in a language: `pages.<locale>/*: update pages`
|
||||
|
||||
For script changes, the commit message/PR title can be (but not limited to) one of the following examples:
|
||||
For script changes, the commit message and the PR title can be (but not limited to) one of the following examples:
|
||||
|
||||
- For a new script addition: `scripts/{{script_name}}: add script`
|
||||
- For a script edit: `scripts/set-alias-page: fix performance issue`
|
||||
|
Loading…
Reference in New Issue
Block a user