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.

Sign up for GitHub

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

Jump to bottom

Auto format issue templates with mdformat tool #452

Open
1 task done
fyliu opened this issue Dec 3, 2024 · 0 comments · May be fixed by #453
Open
1 task done

Auto format issue templates with mdformat tool #452

fyliu opened this issue Dec 3, 2024 · 0 comments · May be fixed by #453
Assignees
@fyliu
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: process improvement role: dev ops s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours
Milestone
04. Project Setup

Comments

@fyliu
Copy link
Member

fyliu commented Dec 3, 2024

Overview

Now that mdformat correctly formats square bracket placeholders: [placeholder], we should enable it for the GitHub issue template directory: .github/ISSUE_TEMPLATE/. Having a tool to auto format makes life easier for us.

Action Items

This capability was discovered while upgrading to the latest mdformat version in pre-commit, so the work was done before writing this issue.

  • Remove exclusion filter in the mdformat hook for the issue template directory and allow it to reformat the files

Resources/Instructions
@fyliu fyliu added feature: process improvement s: PD team stakeholder: People Depot Team role: dev ops size: 0.25pt Can be done in 0.5-1.5 hours complexity: small All steps are laid out in detail so that someone new to the project can work on it labels Dec 3, 2024
@fyliu fyliu added this to the 04. Project Setup milestone Dec 3, 2024
@github-project-automation github-project-automation bot moved this to 🆕New Issue Review in P: PD: Project Board Dec 3, 2024
@fyliu fyliu self-assigned this Dec 3, 2024
@fyliu fyliu moved this from 🆕New Issue Review to 🏗In progress-actively working in P: PD: Project Board Dec 3, 2024
@fyliu fyliu linked a pull request Dec 3, 2024 that will close this issue
Open
@fyliu fyliu changed the title Add issue templates to auto format with mdformat tool Auto format issue templates with mdformat tool Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fyliu fyliu

Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: process improvement role: dev ops s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours
Projects
P: PD: Project Board
Status: 🏗In progress-actively working
Milestone
04. Project Setup
Development

Successfully merging a pull request may close this issue.

mdformat fix all issue templates fyliu/peopledepot
1 participant
@fyliu