-
Notifications
You must be signed in to change notification settings - Fork 48
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
Add Contributing file #58
Add Contributing file #58
Conversation
Signed-off-by: James Busche <jbusche@us.ibm.com>
This is more of acomment, but I feel squash merges should be better than regular merges. It results in a more linear commit history. The slight overhead is that the devs need to know how to rebase branches. But IMO this effort is worth it,. |
Signed-off-by: James Busche <jbusche@us.ibm.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm This is a good starting point. We will add more content as we continue.
Hi @fabianlim, Are you thinking about having me add squash information in the Developer section like this? https://github.com/sigstore/.github/blob/main/CONTRIBUTING.md#squash-commits. Or is this a guideline to make sure the maintainers always choose the |
@jbusche im not sure. it depends on the process for merges. In github you can enforce who merges the PRs. if the repo owner or administrator only can merge the PRs, then as long that person squash merges, it will be fine. But if anybody can merge, then perhaps it should be in CONTRIBUTING. I wonder if the administrators have any thoughts about this. |
Signed-off-by: James Busche <jbusche@us.ibm.com>
Signed-off-by: James Busche <jbusche@us.ibm.com>
@fabianlim, we've added some info that the maintainers will squash and merge as needed to help keep commits more concise. Thanks! |
Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! This is a good start and we will continue to add information on ADR and unit tests
Great, thank you for the reviews @anhuong @Ssukriti @fabianlim! |
* Add Contributing file Signed-off-by: James Busche <jbusche@us.ibm.com> * add issue templates Signed-off-by: James Busche <jbusche@us.ibm.com> * Adding Alex to CODEOWNERS Signed-off-by: James Busche <jbusche@us.ibm.com> * Add ADR and squash info Signed-off-by: James Busche <jbusche@us.ibm.com> * Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> * NIT: Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> --------- Signed-off-by: James Busche <jbusche@us.ibm.com> Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> Co-authored-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
* Add Contributing file Signed-off-by: James Busche <jbusche@us.ibm.com> * add issue templates Signed-off-by: James Busche <jbusche@us.ibm.com> * Adding Alex to CODEOWNERS Signed-off-by: James Busche <jbusche@us.ibm.com> * Add ADR and squash info Signed-off-by: James Busche <jbusche@us.ibm.com> * Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> * NIT: Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> --------- Signed-off-by: James Busche <jbusche@us.ibm.com> Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> Co-authored-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
* Add Contributing file Signed-off-by: James Busche <jbusche@us.ibm.com> * add issue templates Signed-off-by: James Busche <jbusche@us.ibm.com> * Adding Alex to CODEOWNERS Signed-off-by: James Busche <jbusche@us.ibm.com> * Add ADR and squash info Signed-off-by: James Busche <jbusche@us.ibm.com> * Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> * NIT: Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> --------- Signed-off-by: James Busche <jbusche@us.ibm.com> Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> Co-authored-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
* Add Contributing file Signed-off-by: James Busche <jbusche@us.ibm.com> * add issue templates Signed-off-by: James Busche <jbusche@us.ibm.com> * Adding Alex to CODEOWNERS Signed-off-by: James Busche <jbusche@us.ibm.com> * Add ADR and squash info Signed-off-by: James Busche <jbusche@us.ibm.com> * Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> * NIT: Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> --------- Signed-off-by: James Busche <jbusche@us.ibm.com> Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> Co-authored-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
* Add Contributing file Signed-off-by: James Busche <jbusche@us.ibm.com> * add issue templates Signed-off-by: James Busche <jbusche@us.ibm.com> * Adding Alex to CODEOWNERS Signed-off-by: James Busche <jbusche@us.ibm.com> * Add ADR and squash info Signed-off-by: James Busche <jbusche@us.ibm.com> * Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> * NIT: Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> --------- Signed-off-by: James Busche <jbusche@us.ibm.com> Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> Co-authored-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
* Add Contributing file Signed-off-by: James Busche <jbusche@us.ibm.com> * add issue templates Signed-off-by: James Busche <jbusche@us.ibm.com> * Adding Alex to CODEOWNERS Signed-off-by: James Busche <jbusche@us.ibm.com> * Add ADR and squash info Signed-off-by: James Busche <jbusche@us.ibm.com> * Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> * NIT: Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> --------- Signed-off-by: James Busche <jbusche@us.ibm.com> Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com> Co-authored-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
This is first draft of issue #55
This provides a CONTRIBUTING markdown file for new users to provide a guide on how to get involved and contribute to the project.
I'm using the caikit CONTRIBUTING.md document as a template, but changing items to properly fit the FMS instead of caikit convention.
Some things that might need tweaks: