docs: Add CONTRIBUTING.md file link it to README.md #730

addiegupta · 2018-12-11T07:52:30Z

Fixes #729

Changes: There is a section for First Time Contributors to read the ContributionHelp.md but there is no such file. I have added the file and created the required link in README.md

Screenshots for the change:

README.md: Before, without link

README.md: After, with link

ContributionHelp.md: New file

addiegupta · 2018-12-11T07:53:27Z

This is my first pull request so please let me know if I have done something incorrectly

iamareebjamal · 2018-12-11T12:47:44Z

Hi, thanks for the PR. We'll review it shortly, for now, please rename the markdown file to CONTRIBUTING.md

liveHarshit · 2018-12-11T16:11:12Z

@addiegupta Please squash the commits. One PR should have one commit only.

iamareebjamal · 2018-12-11T16:45:44Z

Squashing comes after changes are accepted, or else it becomes difficult for the contributor to squash, do change, and repeat

iamareebjamal · 2018-12-11T16:47:16Z

CONTRIBUTING.md

+
+You’ll now have a local copy of your version of that repository.
+
+*For further details on how to contribute as a first time contributer visit [Contribute to someone's repository](http://kbroman.org/github_tutorial/pages/fork.html)*


External links are not recommended as they can be deleted later.

iamareebjamal · 2018-12-11T16:47:41Z

CONTRIBUTING.md

+
+#### Add a connection to the original owner’s repository.
+
+`$ git remote add foss_remote git://github.com/fossasia/open-event-android`


Suggested change

`$ git remote add foss_remote git://github.com/fossasia/open-event-android`

`$ git remote add upstream git@github.com:fossasia/open-event-android`

iamareebjamal · 2018-12-11T16:50:27Z

CONTRIBUTING.md

+
+`$ git remote add foss_remote git://github.com/fossasia/open-event-android`
+
+Note the distinction between git@github.com: in the first case and git://github.com/ in the second case. I’m not sure why these need to be the way they are, but that’s what works for me.


Remove, because both will work. The first syntax is just doing via SSH. Also, I'd recommend to change both commands to HTTPS versions as that's what will work for beginners who might not have added their SSH keys to Github

iamareebjamal · 2018-12-11T16:51:14Z

CONTRIBUTING.md

+
+Also note 'foss_remote' does not need to be specific. You could very well choose:
+
+`$ git remote add repo_nickname git://github.com/fossasia/open-event-android`


Since, we are not teaching git here, we can skip details and just give instructions

iamareebjamal · 2018-12-11T16:51:40Z

CONTRIBUTING.md

+
+error: failed to push some refs to 'git@github.com:username/the_repo'
+
+Then try `git push origin HEAD:gh-pages` (see stackoverflow.). 


This is a misleading command

iamareebjamal · 2018-12-11T16:52:07Z

CONTRIBUTING.md

+
+Go into the directory for the project and type:
+
+`$ git pull foss_remote master`


First checkout to development

iamareebjamal · 2018-12-11T16:52:38Z

CONTRIBUTING.md

+
+Go into the directory for the project and type:
+
+`$ git pull foss_remote master`


Suggested change

`$ git pull foss_remote master`

`$ git pull upstream development --rebase

iamareebjamal · 2018-12-11T16:53:04Z

CONTRIBUTING.md

+
+Now push them back to your github repository.
+
+`$ git push`


Make them push a single branch to single remote

Thank you for the review! I am currently implementing these changes

CONTRIBUTING.md

addiegupta · 2018-12-17T13:19:49Z

I have updated the changes and updated the branch. Please have a look.

iamareebjamal reviewed Dec 11, 2018

View reviewed changes

iamareebjamal self-assigned this Dec 11, 2018

addiegupta force-pushed the development branch from 7233730 to ce1d71e Compare December 11, 2018 17:33

nikit19 reviewed Dec 11, 2018

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

addiegupta force-pushed the development branch 5 times, most recently from d4f788d to 2565391 Compare December 16, 2018 11:39

fix: Add CONTRIBUTING.md and a link to it in README.md (fossasia#729)

887501b

addiegupta force-pushed the development branch from 2565391 to 887501b Compare December 17, 2018 13:19

iamareebjamal approved these changes Dec 17, 2018

View reviewed changes

iamareebjamal changed the title ~~fix: added ContributionHelp.md file and a link to it in README.md~~ docs: Add CONTRIBUTING.md file and a link to it in README.md Dec 17, 2018

iamareebjamal changed the title ~~docs: Add CONTRIBUTING.md file and a link to it in README.md~~ docs: Add CONTRIBUTING.md file link it to README.md Dec 17, 2018

iamareebjamal merged commit 760c7da into fossasia:development Dec 17, 2018


		You’ll now have a local copy of your version of that repository.

		For further details on how to contribute as a first time contributer visit [Contribute to someone's repository](http://kbroman.org/github_tutorial/pages/fork.html)


		#### Add a connection to the original owner’s repository.

		`$ git remote add foss_remote git://github.com/fossasia/open-event-android`

	`$ git remote add foss_remote git://github.com/fossasia/open-event-android`
	`$ git remote add upstream git@github.com:fossasia/open-event-android`


		`$ git remote add foss_remote git://github.com/fossasia/open-event-android`

		Note the distinction between git@github.com: in the first case and git://github.com/ in the second case. I’m not sure why these need to be the way they are, but that’s what works for me.


		Also note 'foss_remote' does not need to be specific. You could very well choose:

		`$ git remote add repo_nickname git://github.com/fossasia/open-event-android`


		error: failed to push some refs to 'git@github.com:username/the_repo'

		Then try `git push origin HEAD:gh-pages` (see stackoverflow.).


		Go into the directory for the project and type:

		`$ git pull foss_remote master`

	`$ git pull foss_remote master`
	`$ git pull upstream development --rebase

docs: Add CONTRIBUTING.md file link it to README.md #730

docs: Add CONTRIBUTING.md file link it to README.md #730

Uh oh!

Conversation

addiegupta commented Dec 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

addiegupta commented Dec 11, 2018

Uh oh!

iamareebjamal commented Dec 11, 2018

Uh oh!

liveHarshit commented Dec 11, 2018

Uh oh!

iamareebjamal commented Dec 11, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iamareebjamal Dec 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

addiegupta commented Dec 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

addiegupta commented Dec 11, 2018 •

edited

Loading

iamareebjamal Dec 11, 2018 •

edited

Loading

addiegupta commented Dec 17, 2018 •

edited

Loading