mirror of
https://github.com/TheAlgorithms/JavaScript.git
synced 2025-07-06 09:28:26 +08:00
docs: improve the PR template
This commit is contained in:
23
.github/pull_request_template.md
vendored
23
.github/pull_request_template.md
vendored
@ -1,19 +1,26 @@
|
||||
[](https://gitpod.io/from-referrer/) [know more](https://www.gitpod.io/docs/pull-requests/)
|
||||
|
||||
### Describe your change:
|
||||
### Describe your change
|
||||
|
||||
- [ ] Add an algorithm?
|
||||
- [ ] Fix a bug or typo in an existing algorithm?
|
||||
- [ ] Documentation change?
|
||||
- [ ] Miscellaneous changes? <!-- Please explain your changes below. See the following example. -->
|
||||
|
||||
### Checklist:
|
||||
<!-- Remove the issue number section if applicable.
|
||||
|
||||
- [ ] I have read [CONTRIBUTING.md](https://github.com/TheAlgorithms/Javascript/blob/master/CONTRIBUTING.md).
|
||||
- Fix the `DIRECTORY.md` workflow from not committing changes.
|
||||
- Closes #{$ISSUE_NO}
|
||||
-->
|
||||
|
||||
<!--
|
||||
### Checklist
|
||||
|
||||
- [ ] I have read [CONTRIBUTING.md](https://github.com/TheAlgorithms/JavaScript/blob/master/CONTRIBUTING.md).
|
||||
- [ ] This pull request is all my own work -- I have not plagiarized.
|
||||
- [ ] I know that pull requests will not be merged if they fail the automated tests.
|
||||
- [ ] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
|
||||
- [ ] All new JavaScript files are placed inside an existing directory.
|
||||
- [ ] All filenames should use the UpperCamelCase (PascalCase) style. There should be no spaces in filenames.
|
||||
**Example:**`UserProfile.js` is allowed but `userprofile.js`,`Userprofile.js`,`user-Profile.js`,`userProfile.js` are not
|
||||
- [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
|
||||
- [ ] If this pull request resolves one or more open issues then the commit message contains `Fixes: #{$ISSUE_NO}`.
|
||||
- **Example:** `UserProfile.js` is allowed but `userprofile.js`, `Userprofile.js`, `user-Profile.js`, and `userProfile.js` are not.
|
||||
- [ ] All new algorithms have a URL in their comments that points to Wikipedia or similar explanations.
|
||||
- [ ] If this pull request resolves one or more open issues, add `Closes: #{$ISSUE_NO}` to this PR.
|
||||
-->
|
||||
|
Reference in New Issue
Block a user