Skip to content

Commit

Permalink
Add GitHub community documentation
Browse files Browse the repository at this point in the history
Add issue and PR templates and code of conduct.
Move contributing guide to .github folder and merge with the http-interception repo's version.
  • Loading branch information
martincostello committed Feb 22, 2018
1 parent 7bd3769 commit 5ec3999
Show file tree
Hide file tree
Showing 5 changed files with 124 additions and 28 deletions.
36 changes: 36 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing

## Feature requests and bugs

Please submit any feature requests or bugs as an [issue](https://github.com/justeat/JustEat.StatsD/issues) in GitHub.

## Pull requests

The easier your PRs are to review and merge, the more likely your contribution will be accepted. :-)

If you wish to contribute code, please consider the guidelines below:

1. Create an issue detailing the motivation for the change.
1. Fork the repository to your GitHub account.
1. Create a branch to work on your changes.
1. Try to commit changes in a logical manner. Messy histories will be squashed if merged.
1. Please follow the existing code style and [EditorConfig](http://editorconfig.org/) formatting settings so that your file touches are consistent with ours and the diff is reduced.
1. If fixing a bug or adding new functionality, add any tests you deem appropriate.
1. Test coverage should not go down.
1. Note any breaking changes in your PR description.
1. Ensure ```Build.ps1```/```build.sh``` runs with no errors or warnings and all the tests pass.
1. Open a pull request against the ```master``` branch, referencing your issue, if appropriate.

Once your pull request is opened, the project maintainers will assess it for validity and an appropriate level of quality. For example, the Pull Request status checks should all be green.

If the project maintainers are satisfied that your contribution is appropriate it will be merged into the master branch when appropriate and it will then be released when the library is next published to [NuGet](https://www.nuget.org/profiles/JUSTEAT_OSS).

## Releases

* AppVeyor and Travis CI should be green on the master branch.
* Check the version number has been updated since the last release - follow [SemVer rules](http://semver.org)
* Bump the version in `appveyor.yml` and `JustEat.StatsD.Common.props` if neccessary.
* Update the CHANGELOG.md
* Create a new release in [GitHub](https://github.com/justeat/JustEat.StatsD/releases) with appropriate release notes and tagged version number.
* Wait for the tag build to push the package to [NuGet](https://www.nuget.org/packages/JustEat.StatsD) and for the pushed version to be indexed.
* Share the news! 🎉
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### Expected behaviour

_Explain what you expected to happen._

### Actual behaviour

_Explain what actually happened. If an exception occurred, please include a stack trace if available._

### Steps to reproduce

_A concise, repeatable, example of how to illustrate the issue._
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
_Summarise the changes this Pull Request makes._

_Please include a reference to a GitHub issue if appropriate._
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 [through a GitHub issue](https://github.com/justeat/JustEat.StatsD/issues). 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/
28 changes: 0 additions & 28 deletions CONTRIBUTING.md

This file was deleted.

0 comments on commit 5ec3999

Please sign in to comment.