algorithm/JavaScript
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/JavaScript.git synced 2025-07-07 02:05:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve the PR template

Browse Source
This commit is contained in:
David Leal
2022-10-18 19:50:47 -05:00
parent 3573c207af
commit f78f8d6299
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
.github/pull_request_template.md vendored
View File

@ -1,19 +1,26 @@
[![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/) ### Describe your change
### Describe your change:
- [ ] Add an algorithm? - [ ] Add an algorithm?
- [ ] Fix a bug or typo in an existing algorithm? - [ ] Fix a bug or typo in an existing algorithm?
- [ ] Documentation change? - [ ] 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. - [ ] 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. - [ ] 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. - [ ] 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 new JavaScript files are placed inside an existing directory.
- [ ] All filenames should use the UpperCamelCase (PascalCase) style. There should be no spaces in filenames. - [ ] 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 - **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 its comments that points to Wikipedia or other similar explanation. - [ ] 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 then the commit message contains `Fixes: #{$ISSUE_NO}`. - [ ] If this pull request resolves one or more open issues, add `Closes: #{$ISSUE_NO}` to this PR.
-->