-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README.md and CONTRIBUTING.md
- Loading branch information
0 parents
commit 782f591
Showing
2 changed files
with
49 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,28 @@ | ||
# Contributing to [NIT-dgp](https://github.com/NIT-dgp) | ||
These are the overall guidelines for contributing to any Project in NIT-dgp. Please read this before you start contributing to any repo of our organization | ||
|
||
## Code practices | ||
|
||
Please help us follow the best practice to make it easy for the reviewer as well as the contributor. | ||
|
||
- Always work on a new branch while working on an issue. | ||
|
||
- Use Single commit per pull request unless it is a big feature you are working on. | ||
|
||
- Use meaningful commit messages. Your commits in the PR should be in the form | ||
|
||
``` | ||
shortlog: commit message | ||
commit body | ||
Fixes #< issue_no > | ||
``` | ||
where **short log** is the area/filename where you make the change, **commit message** is the very brief description of the change made by you and any other additional details go into the **commit body**. The **Fixes #< issue_no >** is the issue you are working on. | ||
|
||
- In case there are multiple commits on the PR for a small amount of change, the commit author should squash them. | ||
|
||
- Rebase your branch on the latest master and resolve any merge conflicts that occur. | ||
|
||
- Avoid duplicate PRs, if need be comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself. |
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,21 @@ | ||
# NIT-dgp | ||
|
||
[![Join the chat at https://gitter.im/NIT-dgp/General](https://badges.gitter.im/gitterHQ/gitterHQ.github.io.svg)](https://gitter.im/NIT-dgp/General) | ||
|
||
**NIT-dgp** is an Open Source Community started by some GSoC 2016 students of NIT Durgapur to spread the idea of Open Source among students and help them contribute to Open Source. We welcome newcomers who are completely new to open source and help them start their Open Source Journey. | ||
|
||
Start by looking at the repositories at https://github.com/NIT-dgp. Select a repo that you find interesting and pickup one of the issues that seems suitable. But even before that you can join our [#NIT-dgp/general](https://gitter.im/NIT-dgp/General) gitter channel and talk with us. So just drop by and say a Hi! | ||
|
||
If you are a newcomer we recommend choosing a `difficulty/newcomer` issue to get started. | ||
|
||
## Contributing | ||
Please follow our [Contribution guidelines](https://github.com/NIT-dgp/Guidelines/blob/master/CONTRIBUTING.md) before you get started working on any issue. | ||
|
||
# Contact Us | ||
You can contact us in the places mentioned below | ||
|
||
1. [#NIT-dgp/general](https://gitter.im/NIT-dgp/General) gitter channel. This is the one we highly recommend and you will always find someone there to solve our querie | ||
|
||
2. [Mailing list](https://groups.google.com/forum/?hl=en#!forum/nitdopensource) for longer and topic specific discussions | ||
|
||
3. [Facebook Group](https://www.facebook.com/groups/NITDgpOS) **if you are an student of NIT Durgapur**. This will only be used for important announcements and notifications. |