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

Add initial readme instructions #11

Merged
merged 6 commits into from Jan 10, 2019
Merged

Add initial readme instructions #11

merged 6 commits into from Jan 10, 2019

Conversation

Felistas
Copy link
Contributor

@Felistas Felistas commented Jan 8, 2019

Fixes #3

Screenshot:
Contribution.md Preview

screen shot 2019-01-10 at 13 09 33

@Kachulio1 Kachulio1 changed the title Add initial readme instructions [WIP] Add initial readme instructions Jan 9, 2019
@Felistas Felistas changed the title [WIP] Add initial readme instructions [WIP]:Add initial readme instructions Jan 9, 2019
@joaopapereira
Copy link
Member

When you say WIP do you intend to keep on working?
Do you want early feedback?

@FedericoEsparza
Copy link
Member

FedericoEsparza commented Jan 9, 2019

@Felistas Thank you for jumping in and working on this ticket.

What I would like to see, as part of the workflow instructions, is a variant--if not exactly--of the following:

  • Once you decide on an issue to work on (look for the Help Wanted or Good First Issue tags), create a branch from the terminal with the issue number and a short description, for example:

    //Be sure you create your branch from an up-to-date develop branch
    //Don't modify develop. Keep it clean & in sync with this Github repo's develop branch
    git checkout develop
    
    //Update develop branch
    git pull
    
    //Create feature branch
    git checkout -b 17-add-logo
  • When you're ready to submit your changes in a pull-request, first update your develop & your feature branch:

    git checkout develop
    
    git pull
    
    //Switch back to your feature branch
    git checkout 17-add-logo
    
    //Update your feature branch by merging develop
    git merge develop

Keep in mind that if you write instructions for forking the repo, they would have to run git pull upstream develop, instead of just git pull, so you would also want to add instructions on how to add the base Agileventures/Websiteone-FE repo as a remote.

In other words, tell them to run something like this command:

    git remote add upstream https://github.com/AgileVentures/WebsiteOne-FE

@Felistas
Copy link
Contributor Author

Felistas commented Jan 9, 2019

Yes @joaopapereira there are some few things I want to add. I wouldn't mind feedback too. @FedericoEsparza I will definitely implement that.

@Felistas Felistas changed the title [WIP]:Add initial readme instructions Add initial readme instructions Jan 9, 2019
Copy link
Member

@joaopapereira joaopapereira left a comment

Choose a reason for hiding this comment

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

The rest looks pretty good

CONTRIBUTION_GUIDE.md Show resolved Hide resolved

After that run
```
git merge upstream develop
Copy link
Member

Choose a reason for hiding this comment

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

@Felistas Would you mind explaining the purpose of this command git merge upstream develop? I think it might end up confusing newcomers, as it has confused me. Might it not be necessary, since we already ran git pull upstream develop?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@FedericoEsparza I don't think its necessary.You are right.

@FedericoEsparza
Copy link
Member

@Felistas I agree with @joaopapereira . The rest is looking great. I like the initiative to create the CONTRIBUTION_GUIDE.md

Please see my additional comment on that file.

Copy link
Member

@joaopapereira joaopapereira left a comment

Choose a reason for hiding this comment

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

Looks good going to merge

@joaopapereira joaopapereira merged commit 67bdef2 into AgileVentures:develop Jan 10, 2019
mattwr18 pushed a commit that referenced this pull request Jan 22, 2019
* Add initial readme instructions

* Add contributing guide instructions

* Minor edits to the contribution.md file

* hot fix
bryszard pushed a commit that referenced this pull request Apr 13, 2019
* Add initial readme instructions

* Add contributing guide instructions

* Minor edits to the contribution.md file

* hot fix
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

Successfully merging this pull request may close these issues.

None yet

3 participants