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

Create Formatting/Linting End-User Guide #210

Closed
Tracked by #183
damienjburks opened this issue Jun 15, 2024 · 1 comment · Fixed by #223
Closed
Tracked by #183

Create Formatting/Linting End-User Guide #210

damienjburks opened this issue Jun 15, 2024 · 1 comment · Fixed by #223
Labels
All Working Groups Work related to project wide scope delivery Work related to the Delivery WG documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@damienjburks
Copy link
Contributor

damienjburks commented Jun 15, 2024 •
edited
Loading

Feature Request

Create Formatting/Linting End-User Guide

Description of Problem:

We need to ensure that we have an end-user guide for the Git Hooks that should be leveraged so that markdown issues are mitigated prior to committing to a branch and raising a PR.

Potential Solution

Create a document that shows the content creator how to install the necessary tools on their local machines and install the git hook.
@damienjburks damienjburks mentioned this issue Jun 15, 2024
Closed
4 tasks
@damienjburks damienjburks changed the title Create a detailed guide that shows contributors how to install and use the tools locally, use them, and configure the Git Hook. Create Formatting/Linting End-User Guide Jun 15, 2024
@damienjburks damienjburks added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers All Working Groups Work related to project wide scope delivery Work related to the Delivery WG labels Jun 15, 2024
@damienjburks damienjburks added the help wanted Extra attention is needed label Jun 15, 2024
@damienjburks damienjburks mentioned this issue Jun 25, 2024
Merged
@damienjburks damienjburks linked a pull request Jul 9, 2024 that will close this issue
Creation of Global Markdown Formatting and Linting GitHub Actions #223
Merged
@github-actions GitHub Actions
Copy link

This issue will be closed as stale in 7 days. Please update this issue if it is still needed.

@github-actions github-actions bot added the stale label Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
All Working Groups Work related to project wide scope delivery Work related to the Delivery WG documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
FINOS Common Cloud Controls - Project Kanban
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Creation of Global Markdown Formatting and Linting GitHub Actions damienjburks/common-cloud-controls
1 participant
@damienjburks