-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f3059a0
commit d45ee26
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# 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](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork) | ||
- **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](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) 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](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork), before you create a PR | ||
- If your PR is to fix an issue, make sure it contain's GitHub's [keyword reference](https://github.com/blog/1506-closing-issues-via-pull-requests), 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](https://davidwalsh.name/squash-commits-git) 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](http://chris.beams.io/posts/git-commit/) 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](.github/pull_request_template.md) 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.** |