Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Contributing guidelines #346

Merged
merged 1 commit into from
Apr 7, 2016
Merged

Conversation

carlessistare
Copy link
Collaborator

Some guidelines for contributors and code reviewers to be followed


## Making Changes

* Create a topic branch from where you want to base your work.
Copy link
Contributor

Choose a reason for hiding this comment

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

Well, non-contributers won't be able to create topic branch. They will have to fork.

UPDATE: Ah, sorry, I did not read top section. Anyways, better to mention that one is to work with fork )


* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository.
* Make sure that the PR has a clean log message.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe recommend to squash commits? That would help with clean commit history.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Didn't github just add squashed merges?

@carlessistare carlessistare force-pushed the contributing branch 3 times, most recently from 15512b2 to fc66e0f Compare April 2, 2016 17:04
@estliberitas
Copy link
Contributor

Until @haio enables rebase-like merge, I recommend we use rebase instead of merge to avoid those "Merge ...." commits.

https://github.com/blog/2141-squash-your-commits

@carlessistare
Copy link
Collaborator Author

@estliberitas I agree, I added a comment with this.

* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository.
* Make sure that the PR has a clean log message and don't hesitate to squash
and rebase your commits in order to preserve a clean hitory log.
Copy link

Choose a reason for hiding this comment

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

There's a typo in the word "history" here

@estliberitas
Copy link
Contributor

@haio Will you add squash style merging soon? I'd like to use it )

@carlessistare
Copy link
Collaborator Author

The problem of this, is that we cannot easily revert PR am I wrong?
I usually use squash style to merge differet feature PRed in a feature
branch, but not in master, in order to be able unmerge in case of problems.
What do you think?

Le mar. 5 avr. 2016 à 00:13, Alexander Makarenko notifications@github.com
a écrit :

@haio https://github.com/haio Will you add squash style merging soon?
I'd like to use it )


You are receiving this because you authored the thread.

Reply to this email directly or view it on GitHub
#346 (comment)

@estliberitas
Copy link
Contributor

@carlessistare Well, I did not see if github does it for this new feature. If it does not have "Revert" button, then it will be a kinda issue but not that big one.

@hyperlink
Copy link
Collaborator

Squash merge is available.

image

@estliberitas estliberitas merged commit ef0a123 into SOHU-Co:master Apr 7, 2016
@carlessistare carlessistare deleted the contributing branch April 26, 2016 17:10
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants