Skip to content

Commit

Permalink
Contribution and community guides
Browse files Browse the repository at this point in the history
  • Loading branch information
joshfrench committed Sep 15, 2016
1 parent e18b7d5 commit a9f388c
Show file tree
Hide file tree
Showing 2 changed files with 124 additions and 0 deletions.
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# 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
[opensource@upworthy.com](mailto:opensource@upworthy.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/
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
We ❤️ pull requests, and welcome them from all people regardless of age,
nationality, gender, orientation, ethnicity, race, religion, body size, or
level of experience. By participating in this project, you agree to abide by
our [code of conduct][conduct].

### Reporting a bug

Bug reports are always appreciated! Here are some tips to submitting a helpful
bug report:

- Check the existing [issues][issues] first. If your bug has already been
submitted, we still appreciate additional clarifying details.
- Provide a title and clear description, with as much supporting detail as
possible. Include the observed behavior and how it differs from the behavior
you expected.
- Include specific steps to reproduce the bug.
- Better yet, provide a repo containing an isolated test case.
- Screenshots and animated GIFs to demonstrate complex workflows are awesome!

### Contributing code

Fork and clone the repo. Make sure the tests pass before proceeding. Next, add
a failing test. Finally, make it pass!

Push to your repo and open a pull request. We'll try to review it in a timely
fashion, although we're a small team and we thank you for your patience if
we're unable to respond immediately.

Here are some tips to increase the chances we'll accept your patch
with minimal changes:

- Include tests.
- Include documentation for public-facing methods.
- Lint your changes against our house style, with either `npm test` or `npm
run lint`.
- Write a good commit message with a brief, clear summary followed by a more
detailed explanation, if necessary.
- Don't bump the version.

### Getting help

If you have technical questions, please [open an
issue](http://github.com/upworthy/react-mobiledoc-editor/issues). If you have
general questions about our policies, please contact us at
[opensource@upworthy.com](mailto:opensource@upworthy.com).

[issues]: https://github.com/upworthy/react-mobiledoc-editor/issues
[conduct]: ./CODE_OF_CONDUCT

0 comments on commit a9f388c

Please sign in to comment.