Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 2.37 KB

Welcome to the contributions of CS_COURSE_GUIDE

Before contributing

Before contributing, please ensure you have read the complete guidelines. If there are any doubts please open an issue, and clearly state your concerns

We follow a systematic Git Workflow -

  • Create a fork of this repo.
  • Clone your fork of your repo on your pc.
  • Add Upstream to your clone
  • Every change that you do, it has to be on a branch. Commits on master would directly be closed.
  • Create a new branch to fix a issue . Make required no. of commits .Make sure you write proper commit messages.
  • Push the branch to the origin tremote and make a pull request .
  • Make sure that before you create a new branch for new changes,syncing with upstream is neccesary.

Commit Guidelines

  • All commits are to be on a branch. Any on master will be closed
  • It is mandated that your branch is in sync with upstream, before you create a PR
  • If your PR is to fix an issue, make sure it contain's GitHub's keyword reference, which closes the related issue on PR merge
  • If changes are made to your PR, before merge(new commits to fix minor issues, like a failing Travis build), please squash your commits, so you don't have an absurd number of them
  • If your commit is for a UI change, it would be awesome if you add a screenshot, or a link to a deployment where it can be tested out, in your PR. Makes it easy to review and merge
  • Write clear, meaningful git commits
    • We recommend that changes be grouped locally with semantic prefixes to make it easier to understand, but not mandated. For example:

Pull Requests

Check out the pull request template here

Steps to write the readme file .

  • Focus on the issue you are trying to solve
  • Go through the sample readme given in the other folders to understand way the reame markup is written you can also learn about writing the readme markup here

Happy Coding.