Skip to content

Commit 267a8b7

Browse files
tianyizheng02github-actionspre-commit-ci[bot]cclauss
authored
Clarify how to add issue numbers in PR template and CONTRIBUTING.md (#8833)
* updating DIRECTORY.md * Clarify wording in PR template * Clarify CONTRIBUTING.md wording about adding issue numbers * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add suggested change from review to CONTRIBUTING.md Co-authored-by: Christian Clauss <[email protected]> * Incorporate review edit to CONTRIBUTING.md Co-authored-by: Christian Clauss <[email protected]> --------- Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Christian Clauss <[email protected]>
1 parent 331585f commit 267a8b7

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

Diff for: .github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@
1717
* [ ] All function parameters and return values are annotated with Python [type hints](https://docs.python.org/3/library/typing.html).
1818
* [ ] All functions have [doctests](https://docs.python.org/3/library/doctest.html) that pass the automated testing.
1919
* [ ] All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
20-
* [ ] If this pull request resolves one or more open issues then the commit message contains `Fixes: #{$ISSUE_NO}`.
20+
* [ ] 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".

Diff for: CONTRIBUTING.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,12 @@ We appreciate any contribution, from fixing a grammar mistake in a comment to im
2525

2626
Your contribution will be tested by our [automated testing on GitHub Actions](https://github.com/TheAlgorithms/Python/actions) to save time and mental energy. After you have submitted your pull request, you should see the GitHub Actions tests start to run at the bottom of your submission page. If those tests fail, then click on the ___details___ button try to read through the GitHub Actions output to understand the failure. If you do not understand, please leave a comment on your submission page and a community member will try to help.
2727

28-
Please help us keep our issue list small by adding fixes: #{$ISSUE_NO} to the commit message of pull requests that resolve open issues. GitHub will use this tag to auto-close the issue when the PR is merged.
28+
Please help us keep our issue list small by adding `Fixes #{$ISSUE_NUMBER}` to the description of pull requests that resolve open issues.
29+
For example, if your pull request fixes issue #10, then please add the following to its description:
30+
```
31+
Fixes #10
32+
```
33+
GitHub will use this tag to [auto-close the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if and when the PR is merged.
2934

3035
#### What is an Algorithm?
3136

Diff for: DIRECTORY.md

+2
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@
146146
* [Decimal To Binary Recursion](conversions/decimal_to_binary_recursion.py)
147147
* [Decimal To Hexadecimal](conversions/decimal_to_hexadecimal.py)
148148
* [Decimal To Octal](conversions/decimal_to_octal.py)
149+
* [Energy Conversions](conversions/energy_conversions.py)
149150
* [Excel Title To Column](conversions/excel_title_to_column.py)
150151
* [Hex To Bin](conversions/hex_to_bin.py)
151152
* [Hexadecimal To Decimal](conversions/hexadecimal_to_decimal.py)
@@ -411,6 +412,7 @@
411412
* [Dijkstra 2](graphs/dijkstra_2.py)
412413
* [Dijkstra Algorithm](graphs/dijkstra_algorithm.py)
413414
* [Dijkstra Alternate](graphs/dijkstra_alternate.py)
415+
* [Dijkstra Binary Grid](graphs/dijkstra_binary_grid.py)
414416
* [Dinic](graphs/dinic.py)
415417
* [Directed And Undirected (Weighted) Graph](graphs/directed_and_undirected_(weighted)_graph.py)
416418
* [Edmonds Karp Multiple Source And Sink](graphs/edmonds_karp_multiple_source_and_sink.py)

0 commit comments

Comments
 (0)