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

[doc] Improve Contribution Guidelines #152

Closed
kvid opened this issue Aug 13, 2020 · 2 comments
Closed

[doc] Improve Contribution Guidelines #152

kvid opened this issue Aug 13, 2020 · 2 comments

Comments

@kvid
Copy link
Collaborator

kvid commented Aug 13, 2020

I suggest adding some items in the Contribution Guidelines:

  • Recommend creating a separate branch for each feature/bugfix that is pushed to your fork. (Unique branch name for each PR.)
  • Recommend the advises from How to Write a Git Commit Message.
  • If the dev branch has deviated from the PR branch before merge-time, recommend rebasing the PR branch on top of the new dev commits and resolve any conflicts before merge.
  • If the PR branch contains branch merges or a high number of intermediate commits, recommend squashing some of them together using git rebase -i to simplify the commit history before merge.
  • Maybe include the essential git commands?
@formatc1702
Copy link
Collaborator

I've added some of your points in the latest commit to #111.

Maybe include the essential git commands?

I'd rather not write a git tutorial... especially since I am not a CLI git user myself.
And interactive rebasing is an art unto itself.
If you have a good source, we can link to it, though!

@kvid
Copy link
Collaborator Author

kvid commented Aug 15, 2020

I've added some of your points in the latest commit to #111.

Thank's

Maybe include the essential git commands?

I'd rather not write a git tutorial... especially since I am not a CLI git user myself.
And interactive rebasing is an art unto itself.
If you have a good source, we can link to it, though!

I've no such link suggestions at the moment

@kvid kvid closed this as completed Aug 15, 2020
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

No branches or pull requests

2 participants