Skip to content

Commit

Permalink
Add CONTRIIBUTING.md
Browse files Browse the repository at this point in the history
* CONTRIBUTING.md updated

* Add @Razdeep as a contributor

* Updated CONTRIBUTORS.md

* Update CONTRIBUTING.md
  • Loading branch information
Razdeep authored and MadhavBahl committed Dec 19, 2018
1 parent 114adf0 commit 9c30da0
Show file tree
Hide file tree
Showing 4 changed files with 265 additions and 149 deletions.
11 changes: 11 additions & 0 deletions .all-contributorsrc
Expand Up @@ -21,6 +21,17 @@
"design",
"tutorial"
]
},
{
"login": "Razdeep",
"name": "Rajdeep Roy Chowdhury",
"avatar_url": "https://avatars2.githubusercontent.com/u/32531173?v=4",
"profile": "http://www.linkedin.com/in/razdeeproychowdhury",
"contributions": [
"code",
"doc",
"tutorial"
]
}
]
}
109 changes: 107 additions & 2 deletions CONTRIBUTING.md
@@ -1,3 +1,108 @@
# Contribution Guidelines
# Contributing

TBA
When contributing to this repository, please first discuss the change you wish to make via claiming an existing issue or making a new issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

## Pull Request Process and Contribution Guidelines

1. Inside each "Day" Create a folder with the name of language you are contributing in.
2. Ensure you have tested the code you are condtributing atleast 3 times before submitting the pull request.
3. The code you contribute must have this at top -
```cpp
/**
* @author: <GitHub Username>
* @date: <date>
**/
```
We aim to give proper credit to whoever contributes to this repository, hence no Pull Requests will be merged without the @author and @date attribution

##### NOTE: YOU MAY REPLACE THE COMMENT SYNTAX ACCORDING TO THE PROGRAMMING LANGUAGE YOU USE

4. Each folder must also have a README.md with some details about the code one has contributed.
5. Make sure that you have installed Nodejs in your system.
6. Run `npm install` in the command line.
7. Add yourself as contributor using all-contributors-cli by running the following 2 commands on command line (or terminal)
1. `npm run contributors:add -- <username> doc,code`
2. `npm run contributors:generate`.

**Recommended**: Take a look at https://github.com/jfmengels/all-contributors-cli

Looking forward for your contributions πŸ˜„

## Code of Conduct

We have a slack community for our initiatives, you all are welcome to join it: http://codetoexpress.tech/join/

### 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, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

### Our Standards

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

* Using 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 codetoexpress@gmail.com
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][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
6 changes: 3 additions & 3 deletions CONTRIBUTORS.md
@@ -1,13 +1,13 @@

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)
## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars2.githubusercontent.com/u/26179770?v=4" width="100px;"/><br /><sub><b>MADHAV BAHL</b></sub>](http://madhavbahl.tech/)<br />[πŸ’»](https://github.com/MadhavBahlMD/DailyCodeBase/commits?author=MadhavBahlMD "Code") [πŸ“](#blog-MadhavBahlMD "Blogposts") [πŸ“–](https://github.com/MadhavBahlMD/DailyCodeBase/commits?author=MadhavBahlMD "Documentation") [🎨](#design-MadhavBahlMD "Design") [βœ…](#tutorial-MadhavBahlMD "Tutorials") |
| :---: |
| [<img src="https://avatars2.githubusercontent.com/u/26179770?v=4" width="100px;"/><br /><sub><b>MADHAV BAHL</b></sub>](http://madhavbahl.tech/)<br />[πŸ’»](https://github.com/MadhavBahlMD/DailyCodeBase/commits?author=MadhavBahlMD "Code") [πŸ“](#blog-MadhavBahlMD "Blogposts") [πŸ“–](https://github.com/MadhavBahlMD/DailyCodeBase/commits?author=MadhavBahlMD "Documentation") [🎨](#design-MadhavBahlMD "Design") [βœ…](#tutorial-MadhavBahlMD "Tutorials") | [<img src="https://avatars2.githubusercontent.com/u/32531173?v=4" width="100px;"/><br /><sub><b>Rajdeep Roy Chowdhury</b></sub>](http://www.linkedin.com/in/razdeeproychowdhury)<br />[πŸ’»](https://github.com/MadhavBahlMD/DailyCodeBase/commits?author=Razdeep "Code") [πŸ“–](https://github.com/MadhavBahlMD/DailyCodeBase/commits?author=Razdeep "Documentation") [βœ…](#tutorial-Razdeep "Tutorials") |
| :---: | :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

0 comments on commit 9c30da0

Please sign in to comment.