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 the CONTRIBUTING.md guide #1225

Open
Tracked by #1221 ...
jessebraham opened this issue Feb 28, 2024 · 0 comments · May be fixed by #1311
Open
Tracked by #1221 ...

Update the CONTRIBUTING.md guide #1225

jessebraham opened this issue Feb 28, 2024 · 0 comments · May be fixed by #1311
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jessebraham
Copy link
Member

jessebraham commented Feb 28, 2024

I had added a generic contributing guide awhile back with the intentions of re-writing it and adding our project-specific bits, but unfortunately I never really got around to this.

However, now that the HAL has been unified, we are using xtask automation, and the examples require metadata, I think it's important that we clearly document what's required and what's expected for contributors.

Slightly tangential, but we should also update our PR template to point users to this file and ensure they have read it first.

@jessebraham jessebraham added the documentation Improvements or additions to documentation label Feb 28, 2024
@playfulFence playfulFence self-assigned this Mar 19, 2024
@playfulFence playfulFence linked a pull request Mar 19, 2024 that will close this issue
@MabezDev MabezDev added this to the 0.19.0 milestone Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

3 participants