Skip to content

Commit

Permalink
Added License ,Contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
Buddhad committed Sep 28, 2021
1 parent b4b6861 commit 350c61d
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 2 deletions.
43 changes: 43 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

### Attribution
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
### Contributing Guidelines:

[![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend?logo=git&logoColor=white)](https://github.com/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend/compare) [![GitHub contributors](https://img.shields.io/github/contributors/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend?logo=github)](https://github.com/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend/graphs/contributors) [![Buddhadeb Chhetri](https://img.shields.io/badge/[email protected]?colorA=gray&colorB=dodgerblue&logo=github)](https://github.com/Buddhad/)

- Write clear meaningful git commit messages (Do read [this](http://chris.beams.io/posts/git-commit/)).

- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check [this](https://github.com/blog/1506-closing-issues-via-pull-requests) for more info)

- When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at [here](https://davidwalsh.name/squash-commits-git))

- When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.

- Always create PR to `develop` branch.

- Please read our [Code of Conduct](./CODE_OF_CONDUCT.md).

21 changes: 21 additions & 0 deletions License
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright © 2021 Google Developer Student Club - IIIT Kalyani

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
</p>

## **Getting Started**
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend?logo=github)](https://GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend/) [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend?color=bluevoilet&logo=github)](https://github.com/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend/commits/) [![GitHub repo size](https://img.shields.io/github/repo-size/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend?logo=github)](https://github.com/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend)

For the quick start, you can follow the steps below:

Expand Down Expand Up @@ -92,17 +93,20 @@ git push -u origin <your_branch_name>
<h1 id="prs">Issues & Pull Requests</h1>

Before making pull requests please look at our contributing guidelines (coming soon). You can start working on the issue which are mentioned in issues section. Just drop a comment before working on the issue. Thank you!
<hr>

# License & Copyright

The code is this repo is licensed under the [MIT License](License). Feel free to use and share it as per the license.

# ✨ Contributors

<a href="https://github.com/GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend/graphs/contributors">
<img src="https://contrib.rocks/image?repo=GDSC-IIIT-Kalyani/Winter-of-Code-2.0-frontend" />
</a>

<hr>

<div align="center">
<img src="https://forthebadge.com/images/badges/built-with-love.svg" alt="love" />
<img src="https://forthebadge.com/images/badges/thats-how-they-get-you.svg" alt="how">
</div>

0 comments on commit 350c61d

Please sign in to comment.