Skip to content

Latest commit

 

History

History
195 lines (109 loc) · 6.78 KB

CONTRIBUTING.md

File metadata and controls

195 lines (109 loc) · 6.78 KB
Raw

preview-web

Contributor's Guide

Follow the instructions below to install and run the Project locally in less than 15 minutes.

  1. Please Join fccKarachi Organization on github if you still haven't. It is just single click away.

  2. Find an issue that needs assistance by looking in the issues directory of this repo.

  3. Let us know you are working on it by posting a comment on the issue.

  4. Follow the below mentioned Guidelines to start working on the issue.

Guidelines

Prerequisites

  1. Install Node.js (node) latest version.

  2. Verify that you're running node version 7 or above and npm version 5 or above.

    node -v
v9.3.0

npm -v
5.5.1

  3. Make sure you have Git Installed in your system

Forking the Project

Fork this Repo

  1. Fork this repository

Clone it locally

  1. Open a Terminal / Command Line / Bash Shell and navigate to a project directory where you want to copy this project.

    cd yourProjectDirectory

  2. Run below command in your terminal.

    git clone https://github.com/yourUsername/fcckarachi.github.io.git

    (make sure to replace yourUsername with your GitHub Username), This will download the entire fcckarachi.github.io repo to your projects directory.

Install Dependencies

  1. cd into the base directory of your fcckarachi project.

  2. Install the application dependencies.

    npm install

Setup Your Upstream

  1. Add a remote to the official fcckarachi.github.io repo:

     git remote add upstream https://github.com/fcckarachi/fcckarachi.github.io.git

    Congratulations, you now have a local copy of the fcckarachi.github.io repo!

Maintaining Your Fork

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

Rebasing from Upstream

Do this prior to every time you create a branch for a PR:

Make sure you are on the develop branch

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

If your aren't on develop, resolve outstanding files / commits and checkout the develop branch

    git checkout develop

Do a pull with rebase against upstream

    git pull --rebase upstream develop

This will pull down all of the changes to the official develop branch, without making an additional commit in your local repo.

(Optional) Force push your updated develop branch to your GitHub fork

    git push origin develop --force

This will overwrite the develop branch of your fork.

Create A Branch

Everytime 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

Name the branch something like fix/xxx or feature/xxx where xxx is a short description of the changes or feature you are attempting to add. For example fix/cover-image would be a branch where you fix something specific to image on cover section.

Adding Your Branch

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

  git checkout -b [name_of_your_new_branch]

and to push to GitHub:

  git push origin [name_of_your_new_branch]

If you need more help with branching, take a look at this.

Running the App

Start the development server

This command serves the app at http://localhost:1234 and provides basic URL routing for the app:

    npm start

Make Changes

This bit is up to you!

Pull Request

Creating a Pull Request

  1. Add your edited files: git add path/to/filename.ext You can also do: git add . to add all unstaged files. Take care, though, because you can accidentally add files you don't want added. Review your git status first.

  2. Commit your edits.

     git commit -m "Type you commit message here"

  3. If you would want to add/remove changes to previous commit simply add the files as in Step 1 earlier, and use git commit --amend or git commit --amend --no-edit (for keeping the same commit message).

  4. Push your commits to your GitHub Fork: git push -u origin branch/name-here

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

  6. By default, all pull requests should be against the fcckarachi's main repo, develop branch.

  7. Submit a pull request from your branch to fcckarachi's develop branch.

  8. The title (also called the subject) of your PR should be descriptive of your changes and succinctly indicates what is being fixed. i.e Correct typo in home section

  9. In the body of your PR include a more detailed summary of the changes you made and why.

    • If the PR is meant to fix an existing bug/issue then, at the end of your PR's description, append the keyword closes and #xxxx (where xxxx is the issue number). Example: closes #13. This tells GitHub to close the existing issue, if the PR is merged.

Read more on submitting a PR here

If your PR is accepted

Once your PR is accepted, you may delete the branch you created to submit it. This keeps your working fork clean.

You can do this with a press of a button on the GitHub PR interface. You can delete the local copy of the branch with: git branch -D branch/to-delete-name

If your PR is rejected

Don't despair! You should receive solid feedback from us as to why it was rejected and what changes are needed.

Many Pull Requests, especially first Pull Requests, require correction or updating. If you have used the GitHub interface to create your PR, you will need to close your PR, create a new branch, and re-submit.

If you have a local copy of the repo, you can make the requested changes and amend your commit with: git commit --amend This will update your existing commit. When you push it to your fork you will need to do a force push to overwrite your old commit: git push --force

Be sure to post in the PR conversation that you have made the requested changes.

Any Questions?

Feel free to ask any questions by commenting on the issue.