Skip to content

Commit

Permalink
(misc) add contributing guidelines and CoC
Browse files Browse the repository at this point in the history
  • Loading branch information
ripienaar committed Apr 19, 2018
1 parent bb0b084 commit ebcac9e
Show file tree
Hide file tree
Showing 2 changed files with 117 additions and 0 deletions.
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 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 [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/
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# How to contribute

This project relies on your contributions for it's continued success. We want to make the process as easy as possible but a few guidelines are needed.

First please note that participation is bound by our [Code Of Conduct](CODE_OF_CONDUCT.md).

# Issues

We do not have strong guidelines on what you put in an issue, we'll worth with you to gather the information we require but we do ask that you try to put as much detail as possible to help everyone use their time in a meaningful way.

# PRs

Almost every PR will need an issue first. You do not need issues for trivial updates like typos, most documentation updates etc. But if you're doing a PR that adjusts behaviour we will need a issue to go with it.

Once you have an issue note the number and once you are ready to send your PR please squash your commits then make a single commit with something like the following format:

```
(#123) Add a super awesome feature
This adds a new super awesome feature that everyone would love,
it can be used for such and such.
To deliver this feature we had to extend, this that and the other
with new behaviours
Backwards compatability is kept
```

For trivial updates without issues:

```
(misc) Fix typo in README.md
```

Short updates obviously do not need all this, very often I am happy with just a 1 line commit message that matches the first line above.

# Finding others in the community

Usually we like to keep discussions on issues where they relate but of course we are very happy to chat in a more real time manner:

* [Mailing List](https://groups.google.com/forum/#!forum/choria-users)
* [#choria on the Puppet Slack](http://slack.puppet.com/)
* #mcollective on Freenode

0 comments on commit ebcac9e

Please sign in to comment.