Skip to content
This repository has been archived by the owner on Nov 8, 2018. It is now read-only.

Added the Contribution Guide to docs (fix for #102) #124

Merged
merged 1 commit into from
Feb 27, 2017

Conversation

mish24
Copy link

@mish24 mish24 commented Feb 23, 2017

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.

Set up a branch for a particular set of changes and switch to it:

`$ git checkout -b my_branch`
`$ git checkout my_branch`
Copy link

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. :)

Copy link
Author

Choose a reason for hiding this comment

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

Yes. I will remove :)


`$ git checkout -b my_branch`
`$ git checkout my_branch`

Copy link

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. :)


The instructions given below are for software developers who want to work on [our current code](https://github.com/systers/macc).

## Git workflow
Copy link

Choose a reason for hiding this comment

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

How about this order?

  1. What to work on
  2. Coding standards(styles)
  3. Git workflow

Copy link
Author

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)

@mish24
Copy link
Author

mish24 commented Feb 24, 2017

@medhach Ma'am I changed the file according to what you suggested. Order is

  1. What to work on
  2. Coding Guidelines
  3. Git workflow
    Please have a look and suggest improvements

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
@medhach
Copy link

medhach commented Feb 27, 2017

Great job! Thanks for working on this, we needed it!
And you can call me Medha. :)

@medhach medhach merged commit 2595bc7 into systers:develop Feb 27, 2017
@mish24
Copy link
Author

mish24 commented Feb 27, 2017

Thanks a lot :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

Successfully merging this pull request may close these issues.

2 participants