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

Add Contributing file #58

Merged
merged 9 commits into from
Mar 7, 2024

Conversation

jbusche
Copy link
Collaborator

@jbusche jbusche commented Feb 26, 2024

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:

Signed-off-by: James Busche <jbusche@us.ibm.com>
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@fabianlim
Copy link
Collaborator

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,.

jbusche added 2 commits March 1, 2024 10:53
Signed-off-by: James Busche <jbusche@us.ibm.com>
Copy link
Collaborator

@tedhtchang tedhtchang left a 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.

@jbusche
Copy link
Collaborator Author

jbusche commented Mar 1, 2024

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,.

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 squash and merge option of when they merge a PR of multiple commits?

@fabianlim
Copy link
Collaborator

@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.

CODEOWNERS Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
jbusche added 2 commits March 5, 2024 07:58
Signed-off-by: James Busche <jbusche@us.ibm.com>
Signed-off-by: James Busche <jbusche@us.ibm.com>
@jbusche
Copy link
Collaborator Author

jbusche commented Mar 5, 2024

@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>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
Copy link
Collaborator

@Ssukriti Ssukriti left a 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

@Ssukriti Ssukriti merged commit 0d07ee2 into foundation-model-stack:main Mar 7, 2024
3 checks passed
@jbusche
Copy link
Collaborator Author

jbusche commented Mar 7, 2024

Great, thank you for the reviews @anhuong @Ssukriti @fabianlim!

@jbusche jbusche deleted the jb-contributor-md branch March 7, 2024 16:57
jbusche added a commit to jbusche/fms-hf-tuning that referenced this pull request Mar 25, 2024
* 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>
jbusche added a commit to jbusche/fms-hf-tuning that referenced this pull request Mar 25, 2024
* 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>
jbusche added a commit to jbusche/fms-hf-tuning that referenced this pull request Mar 25, 2024
* 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>
anhuong pushed a commit to anhuong/fms-hf-tuning that referenced this pull request Apr 3, 2024
* 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>
anhuong pushed a commit to anhuong/fms-hf-tuning that referenced this pull request Apr 3, 2024
* 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>
anhuong pushed a commit to anhuong/fms-hf-tuning that referenced this pull request Apr 3, 2024
* 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>
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.

5 participants