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

Update contributing guide #1159

Merged
merged 4 commits into from
Oct 20, 2023
Merged

Update contributing guide #1159

merged 4 commits into from
Oct 20, 2023

Conversation

jim
Copy link
Member

@jim jim commented Oct 16, 2023

What it does

Replaces the contents of the current contributing guide with a shorter and up to date list of steps.

Why it is important

This content is in a Google Doc currently, but we may as well keep it with the code.

Implementation notes

  • I also updated the lefthook config that auto-generates the README table of contents. There has been some churn due to different tooling formatting nested lists with different syntax; hopefully this resolves that.

Your bandwidth for additional changes to this PR

Please choose one of the following to help the project maintainers provide the appropriate level of support:

  • I have the time and interest to make additional changes to this PR based on feedback.
  • I am interested in feedback but don't need to make the changes myself.
  • I don't have time or interest in making additional changes to this work.
  • Other or not sure (please describe):

Copy link
Contributor

@phinze phinze left a comment

Choose a reason for hiding this comment

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

Nice improvements!

@jim jim merged commit 83caae2 into main Oct 20, 2023
5 checks passed
@jim jim deleted the jim/readme-markdown-fix branch October 20, 2023 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants