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

Docs: install pre-commit via pipx #199

Closed
5 tasks
fyliu opened this issue Sep 7, 2023 · 1 comment
Closed
5 tasks

Docs: install pre-commit via pipx #199

fyliu opened this issue Sep 7, 2023 · 1 comment
Labels
complexity: missing feature: docs: PD team documentation documentation on PD team processes and architecture, etc. ready for prioritization role: technical writing s: PD team stakeholder: People Depot Team size: 2pt Can be done in 7-12 hours

Comments

@fyliu
Copy link
Member

fyliu commented Sep 7, 2023

Overview

We need to update the pre-commit instructions so that developers know it's required for developers working on the project. Also we want to suggest a better option (pipx) to installing it than globally, which is bad practice.

Action Items

  • Create a new file at docs/howto/tools/pre-commit.md
  • Move instructions from contributing.md and leave a link there to the new file
  • Update the instructions to use pipx
  • Be sure to say that pre-commit is a required part of development
  • check and release ER: Developer support items from #188 #189 from icebox

Resources/Instructions

@fyliu fyliu added size: 2pt Can be done in 7-12 hours s: PD team stakeholder: People Depot Team role: technical writing feature: docs: PD team documentation documentation on PD team processes and architecture, etc. labels Sep 7, 2023
@fyliu fyliu added this to the 5 - Team Workflow milestone Sep 7, 2023
@fyliu
Copy link
Member Author

fyliu commented Dec 16, 2023

Closing this since this issue is already implemented by PR #230.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: missing feature: docs: PD team documentation documentation on PD team processes and architecture, etc. ready for prioritization role: technical writing s: PD team stakeholder: People Depot Team size: 2pt Can be done in 7-12 hours
Projects
Status: ✅Done
Development

No branches or pull requests

3 participants