Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pre commit to remove issue number check #1210

Merged
merged 3 commits into from
Oct 10, 2023

Conversation

michaeljcollinsuk
Copy link
Contributor

@michaeljcollinsuk michaeljcollinsuk commented Oct 9, 2023

📝 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?

  • Changes to documentation and pre-commit config

🧑‍💻 How should the reviewer test these changes?

  • Make a commit, should not require any prefix

📚 Documentation status

  • No changes to the documentation are required
  • This PR includes all relevant documentation
  • Documentation will be added in the future because ... (see #-...)

@michaeljcollinsuk michaeljcollinsuk marked this pull request as ready for review October 9, 2023 15:02
Copy link
Contributor

@ymao2 ymao2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

@michaeljcollinsuk michaeljcollinsuk merged commit 1209a9e into main Oct 10, 2023
@michaeljcollinsuk michaeljcollinsuk deleted the update-pre-commit-check branch October 10, 2023 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 Control panel pre-commit check requires ANPL-prefix
2 participants