Skip to content

Latest commit

 

History

History
100 lines (86 loc) · 6.22 KB

CONTRIBUTING-detailed-instruction.md

File metadata and controls

100 lines (86 loc) · 6.22 KB
Raw

Detailed Instructions

Setup

  1. You need a GitHub account

  2. Install git on your computer.

  3. Fork the scalabridge/curriculum repository:

    1. On GitHub, navigate to the scalabridge/curriculum repository.
    2. In the top-right corner of the page click Fork.

  4. Create a local clone of your fork to put the repository on your local computer:

    1. On GitHub, navigate to your fork of the scalabridge/curriculum repository.

    2. Under your repository name, to the right, click Clone or download.

    3. In the Clone with HTTPs section, click the "Copy to clipboard" icon to copy the clone URL for the repository.

    4. On Linux or Mac, open a terminal, on Windows open Git Bash. From the prompt, if needed, change the working directory to be the one in which you want the repository files created.

    5. Type git clone , and then paste the URL you copied in step 3 above. The command line should look like this, with your GitHub username instead of YOUR-USERNAME:

      $ git clone https://github.com/YOUR-USERNAME/curriculum.git

      Press Enter and git will create your local clone

  5. Link the Github (remote) version of the repository with your local version so it will synchronize before you make changes:

    1. On GitHub, navigate to the scalabridge/curriculum repository.

    2. Under the repository name, to the right, click Clone or download.

    3. In the Clone with HTTPs section, click the "Copy to clipboard" icon to copy the clone URL for the repository.

    4. On Linux or Mac, open a terminal, on Windows open Git Bash. From the prompt, if needed, change the working directory to the location of your local repository.

    5. Type git remote add upstream , and then paste the URL you copied in step 3 above. The command line should look like this:

      $ git remote add upstream https://github.com/scalabridge/curriculum.git

      Press Enter and git will create your local clone

  6. Verify your remote repositories by entering git remote -v. You should see the URL for your fork as origin, and the URL for the scalabridge repository as upstream:

    $ git remote -v
origin  https://github.com/YOUR-USERNAME/curriculum.git (fetch)
origin  https://github.com/YOUR-USERNAME/curriculum.git (push)
upstream        https://github.com/scalabridge/curriculum.git (fetch)
upstream        https://github.com/scalabridge/curriculum.git (push)

Pull Request Work Flow

  1. Syncing your fork: Start with your local and forked repository being up-to-date with scalabridge/master:

    1. Open terminal or Git Bash and change working directory to your local repository
    2. Fetch the branches and their respective commits from the upstream repository. Commits to master will be stored in a local branch, upstream/master.
    3. Then merge the changes from upstream/master into your local master branch.
    4. Finally, update your forked repository on GitHub by pushing the changes to origin:
        $ git fetch upstream  # Fetch the branches and their respective commits
    # From https://github.com/scalabridge/curriculum
    # [new branch]      master     -> upstream/master
    # merge upstream/master into local master
    $ git checkout master
    $ git merge upstream/master
    # push changes to your forked repository
    $ git push origin

  2. Create a topic branch on your local repository.

    1. From the repository directory
    2. git checkout master to make master the base
    3. git checkout -b TOPIC-NAME, where TOPIC-NAME is an appropriate name for branch, e.g "contributing"

  3. Make your changes: hack, hack, edit, hack, edit, ...

  4. Add and commit changes to your topic branch. Refer to the Git Documentation for details on add and commit usage:

    1. Use the git add command to add content to the index that defines the snapshot that will be committed,
    2. Use the git commit command to commit the index to the current working branch, or
    3. Use git commit -a to add and commit all changes.
    $ git add *                # adds all changes to index
$ git add CONTRIBUTING.md  # add single file to index
$ git commit -a            # adds all changes and commits
$ git commit -m "<commit message line here>"

  5. Push your changes to your forked repository. The first time you push your branch use the git push -u command as shown below. Subsequent pushes after further edits can use git push (assumes you are working in branch on local repository).

    # initial push of topic branch
$ git push -u origin your-topic-branch  # origin is your forked repository
# pushes of topic branch after further edits and commits
$ git push         # defaults to your forked repository

  6. Review your change as it appears on your fork of the scalabridge/curriculum repository. Make any additional corrections as needed by repeating steps 3-5 above.

  7. Make your pull request

    1. Go to your forked repository on GitHub
    2. To the right of the Branch menu, click New pull request.
    3. On the Compare page, click compare across forks.
    4. Confirm that the base fork is the repository you'd like to merge changes into. Use the base branch drop-down menu to select the branch of the upstream repository you'd like to merge changes into.
    5. Use the head fork drop-down menu to select your fork, then use the compare branch drop-down menu to select the branch you made your changes in.
    6. Type a title and description for your pull request.
    7. If you would like to allow anyone with push access to the upstream repository to make changes to your PR, then select Allow edits from maintainers.
    8. Click Create pull request.

  8. Pull request review by ScalaBridge team members.

    1. Make revisions as necessary

  9. Squash commits and merge into destination branch of ScalaBridge repository.