Skip to content

Instantly share code, notes, and snippets.

@CuriousLearner

CuriousLearner/CONTRIBUTING.md

Created May 5, 2017 04:52
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save CuriousLearner/8a42f85bf6d10d39ef129a1e92e092c3 to your computer and use it in GitHub Desktop.
Save CuriousLearner/8a42f85bf6d10d39ef129a1e92e092c3 to your computer and use it in GitHub Desktop.
Download ZIP
CONTRIBUTING guidelines for LinuxChix Projects
Raw
CONTRIBUTING.md

Guideline to contribute to the website

  • We accept PRs only on develop branch. No PRs shall be accepted on master branch.

  • We prefer small feature changes instead of bulk changes. That makes it easier for both the developer as well as reviewer. Smaller requests would have a faster turn-around time in the review-response cycle.

Workflow

If you're new to git version control system, please follow these guidelines:

  • Fork the repo.

  • Clone your fork.

  • Add upstream remote as git remote add upstream git@github.com:LinuxChixIndia/LinuxChixIndia.github.io.git

  • Now create a feature branch to work on the bug/feature request like git checkout -b <feature-name>

  • Start working on the issue. Commit early; commit often.

  • Once you get review, address those in next commits. If you get LGTM (Looks good to me) tag on your PR, it's time to get your PR merged. Congrats.

  • Last step is to just squash all your commits into one and briefly describe what you did. (Most of the time, the reviewer shall do this for you, but it would be good if you do it by yourself.)

  • After squashing, you need to force push to your feature branch. git push origin <feature-name> -f

  • Once your PR is merged, it's time to delete the feature branch from your fork (Optional, just to keep your local repo clean) git branch -D <feature-name>

  • Since the master/develop of the original project may be ahead now, it's time to pull the changes from the upstream and update on your fork git pull upstream develop git push origin develop

  • Now for next feature, repeat!

Happy Contributing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment