Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Added references to pre-commit installation#70

Merged
coretl merged 1 commit into
mainfrom
67_add_instructions_to_automatically_install_pre_commit
Feb 15, 2023
Merged

Added references to pre-commit installation#70
coretl merged 1 commit into
mainfrom
67_add_instructions_to_automatically_install_pre_commit

Conversation

@evvaaaa
Copy link
Copy Markdown
Contributor

@evvaaaa evvaaaa commented Feb 6, 2023

Closes #67

Changes to docs. I thought it made sense to explain the pre-commit process in one place in the docs and reference it elsewhere.

  • Added a line in docs/developer/how-to/lint.rst suggesting automatically enabling pre-commit on newly cloned repos for the user.
  • Added a note in docs/user/how-to/existing.rst linking back to docs/developer/how-to/lint.rst.
  • Added a section in docs/user/tutorials/new.rst linking back to docs/developer/how-to/lint.rst.

@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 6, 2023

Codecov Report

Merging #70 (7339a86) into main (e1070b6) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main       #70   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          138       138           
=========================================
  Hits           138       138           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@evvaaaa evvaaaa self-assigned this Feb 6, 2023
@coretl
Copy link
Copy Markdown
Contributor

coretl commented Feb 6, 2023

Looks good, but please can you put the developer/how-to/lint.rst in python3-pip-skeleton rather than python3-pip-skeleton-cli as it needs to appear in all skeleton based projects.

@evvaaaa
Copy link
Copy Markdown
Contributor Author

evvaaaa commented Feb 7, 2023

Looks good, but please can you put the developer/how-to/lint.rst in python3-pip-skeleton rather than python3-pip-skeleton-cli as it needs to appear in all skeleton based projects.

DiamondLightSource/python3-pip-skeleton#120

Copy link
Copy Markdown
Collaborator

@AlexanderWells-diamond AlexanderWells-diamond left a comment

Choose a reason for hiding this comment

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

Just one section that I think should be moved

Comment thread docs/user/tutorials/new.rst Outdated
@evvaaaa evvaaaa force-pushed the 67_add_instructions_to_automatically_install_pre_commit branch from 7df451d to 7339a86 Compare February 8, 2023 08:59
@coretl coretl self-requested a review February 15, 2023 10:32
@coretl coretl merged commit 63677e7 into main Feb 15, 2023
@coretl coretl deleted the 67_add_instructions_to_automatically_install_pre_commit branch February 15, 2023 10:33
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add instructions to automatically install pre-commit

3 participants