Skip to content

Commit

Permalink
added draft contribution guidelines and code of conduct
Browse files Browse the repository at this point in the history
  • Loading branch information
bozdoz committed Aug 14, 2017
1 parent d2408cc commit 275c5d1
Show file tree
Hide file tree
Showing 2 changed files with 104 additions and 0 deletions.
70 changes: 70 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Intro.js 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 <[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.

## 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/
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing

By participating in this project, you agree to abide by the [code of conduct].

[code of conduct]: https://github.com/usablica/intro.js/blob/master/CODE_OF_CONDUCT.md

## Best Practices

Before you post any issue or pull request, search [the issues][issues] and [the pull requests][pulls] to see if it has already been addressed.

[issues]: https://github.com/usablica/intro.js/issues
[pulls]: https://github.com/usablica/intro.js/pulls

Here are some best practices that will help us accept/address pull requests and issues:

* Outline one, **and only one**, specific problem/feature that you are trying to address.
* Write a **good title** that summarizes the specific problem.
* Introduce the problem before you write any code.
* **Help us reproduce the problem** if applicable with a [jsfiddle][jsfiddle]/[codepen][codepen] showcasing the need for a solution.

[jsfiddle]: https://jsfiddle.net/
[codepen]: https://codepen.io/

## Pull Requests

Fork, then clone the repo:

git clone [email protected]:your-username/intro.js.git

Make your changes and push to your fork and [submit a pull request][pr].

[pr]: https://github.com/usablica/intro.js/compare

At this point you're waiting on us. We may suggest some changes or improvements or alternatives.

0 comments on commit 275c5d1

Please sign in to comment.