Update pre commit to remove issue number check #1210
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Summary
Resolves ministryofjustice/analytical-platform#1832
Remove pre-commit restriction for issue number to be included in the commit message.
This is because we have moved from using Jira to Github to track tickets. Additionally, as we are creating issues within the same
data-platform
repo rather than the project repo, linking to the issue is not straightforward (this is explained in detail here: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests) as it would require the full org-name/repo-name to be prefixed each commit to link to the issue.Therefore it would be better to link to the issue in the pull request description only.
Alternatively, we could still require some prefix e.g.
DPAT-...
. However this would not create any link between the issue and commit, and would be purely as our own reference (see previous commit for implementation, can revert to this if preferred).🔍 What should the reviewer concentrate on?
🧑💻 How should the reviewer test these changes?
📚 Documentation status