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

chore(docs): update the contributing and pre-commit documentation #332

Closed
3 tasks
gphorvath opened this issue Apr 1, 2024 · 2 comments · Fixed by #902
Closed
3 tasks

chore(docs): update the contributing and pre-commit documentation #332

gphorvath opened this issue Apr 1, 2024 · 2 comments · Fixed by #902
Assignees
@justinthelaw
Labels
enhancement New feature or request
Milestone
EVERGREEN

Comments

@gphorvath
Copy link
Contributor

  • Remove ADR-Tools instructions if we don't use that
  • Testing section needs to be written
  • Updating our documentation section should cover the website.
@gphorvath gphorvath added the enhancement New feature or request label Apr 1, 2024
@justinthelaw
Copy link
Contributor

justinthelaw commented Apr 1, 2024 •
edited
Loading

There is still a mention of "Zarf project" in the CONTRIBUTING.md.

Also, agree that we can remove mentions of adr-tools and add mentions of pre-commit.

We should also remove mentions of the LFAI discord.

See https://github.com/justinthelaw/repository-template/blob/main/.github/CONTRIBUTING.md as a reference.

@justinthelaw
Copy link
Contributor

Bumping this to include the following:

  • add pre-commit instructions
  • add local testing steps (dev, docker, k8s)
  • release-please (dev and official) release workflows
  • PRs and commit etiquette

Use this as an example starting point: https://github.com/justinthelaw/uds-rke2/blob/main/.github/CONTRIBUTING.md

@justinthelaw justinthelaw self-assigned this Jul 11, 2024
@justinthelaw justinthelaw added this to the EVERGREEN milestone Jul 11, 2024
@justinthelaw justinthelaw changed the title CONTRIBUTING.md needs update chore(docs): update the contributing and pre-commit documentation Jul 11, 2024
@justinthelaw justinthelaw linked a pull request Aug 12, 2024 that will close this issue
chore(docs): markdown linting and improved documentation #902
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@justinthelaw justinthelaw

Labels
enhancement New feature or request
Projects
None yet
Milestone
EVERGREEN
Development

Successfully merging a pull request may close this issue.

chore(docs): markdown linting and improved documentation defenseunicorns/leapfrogai
2 participants
@gphorvath @justinthelaw