Skip to content

Commit

Permalink
Adding guidelines for contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
aholstenson committed Jan 23, 2018
1 parent bd8c8d9 commit 7e4c84a
Showing 1 changed file with 104 additions and 0 deletions.
104 changes: 104 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Contributing

Contributions are welcomed in this repository, not only code changes but also
opening issues, helping with questions and otherwise giving feedback.

Please note that this project has a code of conduct, please read it before
jumping in and contributing to this project.

## Working with the code

This project doesn't have a super-strict code-style, contributions are expected
to look about the same as existing code. Tabs are used for indentation except
for Markdown and a few JSON-files. Install an [Editorconfig](http://editorconfig.org/)
plugin in your editor to simplify white-space handling.

Before submitting a pull request, run `npm test` to run a few basic linting
tests. If you have an ESLint-plugin in your editor it should run automatically
while you work.

## Issues and helping out with questions

This project is used both directly by developers and indirectly by end-users
via other projects. When opening an issue try to include as much details about
how the library is used, such as if its being used via a third-party project
and the version being used.

If you have know-how about the API and library please feel free to answer any
questions you can. If you have the same issue as someone else, try adding a few
more details if you can.

## 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 main developer 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][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/

0 comments on commit 7e4c84a

Please sign in to comment.