Skip to content

Latest commit

 

History

History
136 lines (84 loc) · 5.15 KB

CONTRIBUTING.md

File metadata and controls

136 lines (84 loc) · 5.15 KB
Raw

Portfolio Challenge

Do you have a portfolio site? Open a PR to this repository and add yourself as an open source contributor this October!

Here's how to create a Pull Request

  1. Fork this repository.
  2. Clone your new repository to your system.
  3. Create a new branch (i.e. add/your-name).
  4. Add your new site alphabetically to the list.
  5. Commit changes and push the new branch.
  6. Open and submit a PR.

If this is your fisrt PR and need direction, read more below.

Contributor's Guide

Steps:

  1. Setting up your system by installing Git or your favorite Git client.

  2. Forking the repository

  • Go to the top level page of this repository.
  • Click the "Fork" Button in the upper right hand corner of the interface (More Details).
  • After the repository has been forked, you will be taken to your copy of the repo at https://github.com/yourUsername/hacktober-special.
  1. Cloning Your Fork
  • Open a Terminal / Command Line in your project's directory.
  • Clone your fork of hacktober-special repository.
$ git clone https://github.com/yourUsername/hacktober-special.git

(in the above command replace yourUsername with your GitHub username)

Now you have a local copy of the hacktober-special repository.

  1. Maintaining Your Fork

Now that you have a copy of your fork, there is work you will need to do to keep it current.

Rebase from upstream prior to every time you create a branch for a PR:

  • Make sure you are on the master branch.
$ git status
On branch master
Your branch is up to date with 'origin/master'.
  • Do a pull with rebase against master
$ git pull --rebase upstream master

This will pull down all of the changes to the official master branch, without making an additional commits in your local repository.

  • Merge remote changes to your local master fork:
$ git merge upstream/master
  1. Create a Branch

Before you start working, you will need to create a separate branch specific to the issue / feature you're working on. You will push your work to this branch.

  • Naming Your Branch

You could name the branch something that relevant to your new site i.e., add/your-name

  • Adding Your Branch

To create a branch on your local machine (and switch to this branch):

$ git checkout -b [add/your-name]

and to push to GitHub:

$ git push origin [add/your-name]

If you need more help with branching, refer this. It is important to always edit only on the branch.

  1. Creating a Pull Request

Editing via your Local Fork is the recommended method. Read about How to Setup and Maintain a Local Instance.

1). Perform the maintenance step of rebasing master.

2). Ensure you are on the master branch using git status:

    $ git status
    On branch master
    Your branch is up-to-date with 'origin/master'.

    nothing to commit, working directory clean

3). If you are not on master, checkout git checkout master

4). Create a branch off with git command: git checkout -b add/your-name

5). Edit your file(s) locally with the editor of your choice.

6). Check your git status to see unstaged files.

7). Add your edited files: git add path/to/filename.ext You can also do: git add . to add all unstaged files. Review your git status first.

8). Make sure your new site is added alphabetically to the existing list.

9). Commit your edits. git commit -m "your-commit-message" . Write a commit message that summarizes the changes.

See Useful Tips for writing better Git commit messages for reference.

Try to use the present tense for your commit messages (i.e. Add instead of Added).

10). If you would want to add/remove changes to previous commit, add the files and use git commit --amend or git commit --amend --no-edit (for keeping the same commit message).

11). Push your commits to your GitHub Fork: git push origin add/your-name

12). Once the edits have been committed, you will be prompted to create a pull request on your fork's GitHub Page.

13). By default, all pull requests should be against the main repository, master branch. Make sure that your Base Fork is set to hacktober-special/master when raising a Pull Request.

14). Submit a pull request from your branch to hacktober-special master branch.

15). The subject of your PR should be descriptive of your changes and indicate what is being fixed.

Once your PR is accepted, you may delete the branch you created to submit it. You can delete the local copy of the branch with: git branch -D branch/to-delete-name