-
Notifications
You must be signed in to change notification settings - Fork 51
Added the Contribution Guide to docs (fix for #102) #124
Conversation
db4b9a5
to
d8a957d
Compare
docs/Contribution.md
Outdated
Set up a branch for a particular set of changes and switch to it: | ||
|
||
`$ git checkout -b my_branch` | ||
`$ git checkout my_branch` |
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.
Doesn't git checkout -b my_branch take you into my_branch? I think this line could be removed. :)
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.
Yes. I will remove :)
docs/Contribution.md
Outdated
|
||
`$ git checkout -b my_branch` | ||
`$ git checkout my_branch` | ||
|
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.
And maybe you should also mention that a request can be pulled without creating a new branch explicitly. That would be 1 request at a time, but its still a good option I think. :)
docs/Contribution.md
Outdated
|
||
The instructions given below are for software developers who want to work on [our current code](https://github.com/systers/macc). | ||
|
||
## Git workflow |
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.
How about this order?
- What to work on
- Coding standards(styles)
- Git workflow
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.
Git workflow should be explained first I suppose?
Then what to work on, and the guidelines to follow (coding styles)
7c3ec4e
to
756ec4e
Compare
@medhach Ma'am I changed the file according to what you suggested. Order is
|
changes new changes new changes2 new changes3 new changes4 Final commit Added a separate contribution file to docs new change Added a separate contribution guide to docs type fix Added a separate Contribution Guide to docs updated readme made certain edits Added a separate contribution file and updated README final edits Added a separate contribution guide to docs
Great job! Thanks for working on this, we needed it! |
Thanks a lot :) |
Gives information about how to set up remote, keep the origin and upstream synced, styling guidelines to follow, necessary steps while sending PRs. Addresses issue #102 @medhach Please review ma'am.