Skip to content

Commit 00648bc

Browse files
authored
docs: improve the PR template
1 parent 3573c20 commit 00648bc

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

.github/pull_request_template.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
1-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) [know more](https://www.gitpod.io/docs/pull-requests/)
2-
3-
### Describe your change:
1+
### Describe your change
42

53
- [ ] Add an algorithm?
64
- [ ] Fix a bug or typo in an existing algorithm?
75
- [ ] Documentation change?
6+
- [ ] Miscellaneous changes? <!-- Please explain your changes below. See the following example. -->
7+
8+
<!-- Remove the issue number if applicable.
9+
10+
- Fix the `DIRECTORY.md` workflow from not committing changes.
11+
- Closes #{$ISSUE_NO}
12+
13+
-->
814

9-
### Checklist:
15+
### Checklist
1016

11-
- [ ] I have read [CONTRIBUTING.md](https://github.com/TheAlgorithms/Javascript/blob/master/CONTRIBUTING.md).
17+
- [ ] I have read [CONTRIBUTING.md](https://github.com/TheAlgorithms/JavaScript/blob/master/CONTRIBUTING.md).
1218
- [ ] This pull request is all my own work -- I have not plagiarized.
1319
- [ ] I know that pull requests will not be merged if they fail the automated tests.
1420
- [ ] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
1521
- [ ] All new JavaScript files are placed inside an existing directory.
1622
- [ ] All filenames should use the UpperCamelCase (PascalCase) style. There should be no spaces in filenames.
17-
**Example:**`UserProfile.js` is allowed but `userprofile.js`,`Userprofile.js`,`user-Profile.js`,`userProfile.js` are not
18-
- [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
19-
- [ ] If this pull request resolves one or more open issues then the commit message contains `Fixes: #{$ISSUE_NO}`.
23+
- **Example:** `UserProfile.js` is allowed but `userprofile.js`, `Userprofile.js`, `user-Profile.js`, and `userProfile.js` are not.
24+
- [ ] All new algorithms have a URL in their comments that points to Wikipedia or similar explanations.
25+
- [ ] If this pull request resolves one or more open issues, add `Closes: #{$ISSUE_NO}` to this PR.

0 commit comments

Comments
 (0)