Add code of conduct and contribution guidelines

This commit is contained in:
James Dinsdale 2017-01-27 17:13:29 +00:00
parent 9b24479f1c
commit e9bfec2ba9
No known key found for this signature in database
GPG key ID: 3D8EDF4F3967CD54
2 changed files with 137 additions and 0 deletions

74
code-of-conduct.md Normal file
View file

@ -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 hi@molovo.co. 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/

63
contributing.md Normal file
View file

@ -0,0 +1,63 @@
# Contributing to ZUnit
✨ Thanks for contributing to ZUnit! ✨
Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
## How can I contribute?
### Improve documentation
As a user of ZUnit you're the perfect candidate to help us improve our documentation. Typo corrections, error fixes, better explanations, more examples, etc. Open issues for things that could be improved. Anything. Even improvements to this document.
Use the [`docs` label](https://github.com/molovo/zunit/labels/docs) to find suggestions for what we'd love to see more documentation on.
### Improve issues
Some issues are created with missing information, not reproducible, or plain invalid. Help make them easier to resolve. Handling issues takes a lot of time that we could rather spend on fixing bugs and adding features.
### Give feedback on issues
We're always looking for more opinions on discussions in the issue tracker. It's a good opportunity to influence the future direction of ZUnit.
The [`question` label](https://github.com/molovo/zunit/labels/question) is a good place to find ongoing discussions.
### Write code
You can use issue labels to discover issues you could help out with:
* [`blocked` issues](https://github.com/molovo/zunit/labels/blocked) need help getting unstuck
* [`bug` issues](https://github.com/molovo/zunit/labels/bug) are known bugs we'd like to fix
* [`enhancement` issues](https://github.com/molovo/zunit/labels/enhancement) are features we're open to including
* [`performance` issues](https://github.com/molovo/zunit/labels/performance) track ideas on how to improve ZUnits performance
The [`help wanted`](https://github.com/molovo/zunit/labels/help%20wanted) and [`good for beginner`](https://github.com/molovo/zunit/labels/good%20for%20beginner) labels are especially useful.
You may find an issue is assigned, or has the [`assigned` label](https://github.com/molovo/zunit/labels/assigned). Please double-check before starting on this issue because somebody else is likely already working on it.
We'd like to fix [`priority` issues](https://github.com/molovo/zunit/labels/priority) first. We'd love to see progress on [`low-priority` issues](https://github.com/molovo/zunit/labels/low%20priority) too. [`future` issues](https://github.com/molovo/zunit/labels/future) are those that we'd like to get to, but not anytime soon. Please check before working on these since we may not yet want to take on the burden of supporting those features.
### Hang out in our chat
We have a [chat](https://gitter.im/molovo/zunit). Jump in there and lurk, talk to us, and help others.
## Submitting an issue
- The issue tracker is for issues. Use our [chat](https://gitter.im/molovo/zunit) for support.
- Search the issue tracker before opening an issue.
- Ensure you're using the latest version of ZUnit.
- Use a clear and descriptive title.
- Include as much information as possible: Steps to reproduce the issue, error message, ZSH version, operating system, etc.
- The more time you put into an issue, the more we will.
- [The best issue report is a failing test proving it.](https://twitter.com/sindresorhus/status/579306280495357953)
## Submitting a pull request
- Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work.
- For ambitious tasks, you should try to get your work in front of the community for feedback as soon as possible. Open a pull request as soon as you have done the minimum needed to demonstrate your idea. At this early stage, don't worry about making things perfect, or 100% complete. Add a [WIP] prefix to the title, and describe what you still need to do. This lets reviewers know not to nit-pick small details or point out improvements you already know you need to make.
- New features should be accompanied with tests and documentation.
- Don't include unrelated changes.
- Make the pull request from a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches), not master.
- Use a clear and descriptive title for the pull request and commits.
- Write a convincing description of why we should land your pull request. It's your job to convince us. Answer "why" it's needed and provide use-cases.
- You might be asked to do changes to your pull request. There's never a need to open another pull request. [Just update the existing one.](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md)