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: update contributing guide #1593

Closed
2 tasks done
SauravMaheshkar opened this issue Jul 22, 2024 · 1 comment · Fixed by #1623
Closed
2 tasks done

docs: update contributing guide #1593

SauravMaheshkar opened this issue Jul 22, 2024 · 1 comment · Fixed by #1623
Assignees

Comments

@SauravMaheshkar
Copy link
Collaborator

SauravMaheshkar commented Jul 22, 2024

Perhaps we should update our contributing guide. A few things I had in mind

  • Add a note about CI. Explain how the CI works and what workflows are expected to pass in the contributing process.
  • Possibly merge pre-commit instructions in the contributing guide.
  • Possibly? CONTRIBUTING.md -> .github/CONTRIBUTING.md.
@guarin
Copy link
Contributor

guarin commented Jul 22, 2024

Add a note about CI. Explain how the CI works and what workflows are expected to pass in the contributing process.

A note about the CI would definitely help, especially about when CI is triggered (new contributors etc.). Required workflows should be pretty easy to spot because they are marked "Required" in action checks overview, but would be good to mention this as well.

Possibly merge pre-commit instructions in the contributing guide.

Yep, sounds good to me.

Possibly? CONTRIBUTING.md -> .github/CONTRIBUTING.md.

Let's keep it on the top level, it makes the document easier to discover. It also makes it clear that all commands described in the document have to be executed from the top level.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants