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

CONTRIBUTING.md - add some notes about feature branches #659

Merged
merged 6 commits into from
Jan 14, 2023

Conversation

andrewm4894
Copy link
Collaborator

@andrewm4894 andrewm4894 commented Jan 12, 2023

  • try nudge people towards using a feature branch in their fork instead of their main.
  • add note about squash and merge,
  • link to an example PR as a sort of reference.
  • add a "Tips" section with some tips.

@github-actions
Copy link

pre-commit failed.
Please run pre-commit run --all-files locally and commit the changes.
Find more information in the repository's CONTRIBUTING.md

@andrewm4894 andrewm4894 changed the title add some notes about feature branches CONTRIBUTING.md - add some notes about feature branches Jan 12, 2023
@andrewm4894 andrewm4894 marked this pull request as ready for review January 12, 2023 14:48
@andrewm4894 andrewm4894 enabled auto-merge (squash) January 12, 2023 14:49
@andrewm4894
Copy link
Collaborator Author

wups - did this quick in browser and made branch in LAION-AI repo by mistake instead of my fork. I will be sure to delete that branch once closed.


- At any point you can compare your feature branch to the upstream/main of
`LAION-AI/Open-Assistant` but using a URL like this:
https://github.com/LAION-AI/Open-Assistant/compare/main...andrewm4894:Open-Assistant:my-example-feature-branch.
Copy link
Collaborator

@fozziethebeat fozziethebeat Jan 13, 2023

Choose a reason for hiding this comment

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

Maybe make this an env variable: ${MY_GITHUB_HANDLE}

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I kinda wanted to have a link they could click and see something so they can see a real example and what to expect and then just adjust the url for their own use case.

actually might try get best of both worlds by updating the text below.

Copy link
Collaborator

@fozziethebeat fozziethebeat left a comment

Choose a reason for hiding this comment

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

This will help. Maybe take a look at this other project's instructions and crib some of the steps.

@github-actions
Copy link

pre-commit failed.
Please run pre-commit run --all-files locally and commit the changes.
Find more information in the repository's CONTRIBUTING.md

1 similar comment
@github-actions
Copy link

pre-commit failed.
Please run pre-commit run --all-files locally and commit the changes.
Find more information in the repository's CONTRIBUTING.md

Copy link
Collaborator

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

@andrewm4894 andrewm4894 merged commit b44305d into main Jan 14, 2023
@andrewm4894 andrewm4894 deleted the update-contributing-about-feature-branches branch January 14, 2023 21:36
@andrewm4894 andrewm4894 restored the update-contributing-about-feature-branches branch January 14, 2023 22:04
@andrewm4894 andrewm4894 deleted the update-contributing-about-feature-branches branch January 14, 2023 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants