Skip to content

Commit

Permalink
📝 Contributing guidelines, code of conduct and templates (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
nlepage committed Jul 4, 2017
1 parent e3508bc commit c7a34f3
Show file tree
Hide file tree
Showing 4 changed files with 133 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# 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, 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 nicolas.lepage@zenika.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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/
49 changes: 49 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing to immutad●t
First of all thank you for the interest you show in immutad●t ! :+1:<br />
We are very happy to welcome new contributors. :tada:

## How can I contribute ? :man_technologist:
### Report a bug :bug:
If you think you have found a bug, please search [our issue tracker][issues] to see if anyone has already reported it.<br />
If you are the first to have noticed it, please [create an issue][new_issue], and make sure to provide any information that might help us resolve it.<br />
You are welcome to try and fix it by submitting a pull request if you would like to (see Pull requests section for more information).

### Feature requests and enhancements :sparkles:
We are open to feature requests, be sure to search [our issue tracker][issues] to see if anyone has already asked for it.<br />
If not, please [create an issue][new_issue] describing what you want, what is your use case, and an example of code.<br />
You are welcome to try and do it yourself by submitting a pull request if you would like to (see Pull requests section for more information).<br />
As immutad●t is still a very young project, we are also open to enhancement suggestions ; if you think of anything that might help us improve the project, please [create an issue][new_issue] and we will be happy to discuss it with you.

### Pull requests :arrow_up:
#### Installation :package:
We use [yarn](https://yarnpkg.com/) but you are free to use [npm](https://www.npmjs.com/) if you prefer.<br />
Once you have cloned the project, run `yarn` or `npm install` to install all the dependencies.

#### Architecture :house:
We have only one peer dependency on [lodash](https://lodash.com/) and we intend to keep it that way.<br />
immutad●t is organized in namespaces (array, collection, lang, etc.), a lot like lodash, please try to respect this organization ; if you are not sure where to put your code, ask for the right place in your issue or PR.

#### Tests and Code style :policeman:
I you write any code, be sure to write the test going with it in a file located at the same place and named `<something>.spec.js` ; we have a coverage of a :100: percent and we would like to keep it :wink:.<br />
We use [eslint](http://eslint.org/) to enforce some coding rules (2 spaces indentation, etc.), ideally use an IDE to help you comply with these rules.<br />
Before pushing anything, please be sure to check that the tests are OK by running `yarn test` or `npm test` and that your code complies with the coding rules by running `yarn lint` or `npm run lint`.

#### Documentation :bulb:
The better the documentation, the less questions users will ask themeselves.<br />
We [use jsdoc](http://usejsdoc.org/) to document our code, if you write any new code please write the documentation with it and try to conform to the existing documention.<br />
If you want to see the result of what you wrote you can run `yarn docs` or `npm run docs`, it will generate the documentation in `docs/<version>/`.<br />
:warning: Please do not commit the files generated in `docs/`, it is automatically updated once we create a new tag.

#### emojis :beers:
We really :heart: emojis, and we would like you to share our :heart:.<br />
Each and every commit message has to be prefixed by an emoji.<br />
Please refer to [the gitmoji guide](https://gitmoji.carloscuesta.me/) to know which one to use.

## I have a question :question:
If you are not sure whether to report a bug or ask for a new feature, or if you just have a question about anything, please [create an issue][new_issue].

## Code of conduct :page_facing_up:
In order to keep a happy and respectful atmosphere around the project, we expect everyone participating in it to follow our [Code of conduct](https://github.com/Zenika/immutadot/blob/master/.github/CODE_OF_CONDUCT.md).

[issues]: https://github.com/Zenika/immutadot/issues
[new_issue]: https://github.com/Zenika/immutadot/issues/new
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
### Prerequisites
- [ ] I have read the [Contributing guidelines](https://github.com/Zenika/immutadot/blob/master/.github/CONTRIBUTING.md)
- [ ] I have read the [Code of conduct](https://github.com/Zenika/immutadot/blob/master/.github/CODE_OF_CONDUCT.md) and I agree with it

### Description
[Description of the issue]

### Only for bugs :bug:
**Version :** [The version of immutadot you are using]

#### Expected behavior
[What you expect to happen]

#### Actual behavior
[What actually happens]

#### How to reproduce
[Steps to reproduces the bug, or a simple example on [runkit](https://runkit.com/)]

### Only for feature requests :sparkles:

#### Example
```js
// An example of code using the feature
```
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### Prerequisites
- [ ] I have read the [Contributing guidelines](https://github.com/Zenika/immutadot/blob/master/.github/CONTRIBUTING.md)
- [ ] I have read the [Code of conduct](https://github.com/Zenika/immutadot/blob/master/.github/CODE_OF_CONDUCT.md) and I agree with it

### Description
[Description of the pull request]

**Issue :** [Reference to the issue]

## Example usage
```js
// An example of code using what you made
```

0 comments on commit c7a34f3

Please sign in to comment.