|
1 | | -### Describe your change: |
2 | | - |
3 | | - |
4 | | - |
5 | | -* [ ] Add an algorithm? |
6 | | -* [ ] Fix a bug or typo in an existing algorithm? |
7 | | -* [ ] Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request. |
8 | | -* [ ] Documentation change? |
9 | | - |
10 | | -### Checklist: |
11 | | -* [ ] I have read [CONTRIBUTING.md](https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md). |
12 | | -* [ ] This pull request is all my own work -- I have not plagiarized. |
13 | | -* [ ] I know that pull requests will not be merged if they fail the automated tests. |
14 | | -* [ ] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms. |
15 | | -* [ ] All new Python files are placed inside an existing directory. |
16 | | -* [ ] All filenames are in all lowercase characters with no spaces or dashes. |
17 | | -* [ ] All functions and variable names follow Python naming conventions. |
18 | | -* [ ] All function parameters and return values are annotated with Python [type hints](https://docs.python.org/3/library/typing.html). |
19 | | -* [ ] All functions have [doctests](https://docs.python.org/3/library/doctest.html) that pass the automated testing. |
20 | | -* [ ] All new algorithms include at least one URL that points to Wikipedia or another similar explanation. |
21 | | -* [ ] If this pull request resolves one or more open issues then the description above includes the issue number(s) with a [closing keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue): "Fixes #ISSUE-NUMBER". |
| 1 | +## 📝 Description of Changes |
| 2 | + |
| 3 | +Hello! 👋 Please provide a detailed description of what your pull request does. |
| 4 | +Explain the problem you’re solving, the motivation behind your changes, and any context that might help the maintainers understand your work. |
| 5 | + |
| 6 | +For example: |
| 7 | +- What issue or bug does this PR address? |
| 8 | +- Why is this change important or helpful? |
| 9 | +- Are there any design decisions or trade-offs to note? |
| 10 | + |
| 11 | +Fixes #(issue number) if applicable. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## 🌟 Motivation & Context |
| 16 | + |
| 17 | +Give a little background to help reviewers understand your thought process. |
| 18 | +This is your chance to explain *why* you approached the problem the way you did. |
| 19 | + |
| 20 | +For example: |
| 21 | +- Did you find a more efficient solution? |
| 22 | +- Are you adding new functionality that didn’t exist before? |
| 23 | +- Did you improve documentation, readability, or testing? |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +## 📸 Screenshots / Output (if applicable) |
| 28 | + |
| 29 | +If your PR changes visuals, algorithm output, or logs, please add screenshots, gifs, or text samples here. |
| 30 | +This makes it easier for maintainers to review and understand your work. |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## ✅ Type of Change |
| 35 | + |
| 36 | +Please select one or more options that apply: |
| 37 | + |
| 38 | +- [ ] 🐛 Bug fix – Non-breaking change that fixes an issue |
| 39 | +- [ ] ✨ New feature – Adds new functionality |
| 40 | +- [ ] ⚡ Enhancement / Refactor – Improves or optimizes existing code |
| 41 | +- [ ] 📝 Documentation update – Improves instructions, examples, or guides |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## 📋 Checklist |
| 46 | + |
| 47 | +Before submitting your PR, please check off the following: |
| 48 | + |
| 49 | +- [ ] I have read and understood the [CONTRIBUTING.md](CONTRIBUTING.md) guide |
| 50 | +- [ ] This PR is my own work and not copied from elsewhere |
| 51 | +- [ ] My code follows the project’s coding style, naming conventions, and best practices |
| 52 | +- [ ] I have added or updated tests/doctests where necessary |
| 53 | +- [ ] All automated tests, linting, and formatting pass successfully |
| 54 | +- [ ] I have added links or references to relevant issues, documentation, or sources |
| 55 | +- [ ] I have provided screenshots, output, or examples if applicable |
| 56 | +- [ ] I have explained the motivation and context clearly above |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +## 🔗 Related Issues / References |
| 61 | + |
| 62 | +List any related issues, discussions, or external references here. |
| 63 | +Use the GitHub closing keywords if your PR resolves issues automatically (e.g., `Fixes #123`). |
| 64 | + |
| 65 | +--- |
| 66 | + |
| 67 | +💡 **Tip for contributors:** |
| 68 | +Try to make your PR description as clear as possible. Imagine you’re explaining your changes to someone seeing the project for the first time — this helps maintainers review faster and increases the chances your PR will be merged smoothly. |
0 commit comments