Add contributing guidelines, along with CoC

This commit is contained in:
Brandon Keepers 2016-09-12 15:31:21 -05:00
Родитель 2d0c567431
Коммит 070294cd4b
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: F9533396D5FACBF6
3 изменённых файлов: 112 добавлений и 9 удалений

74
CODE_OF_CONDUCT.md Normal 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 opensource@github.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/

36
CONTRIBUTING.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
# Contributing to this survey
Thanks for checking out the Open Source Survey! We're excited to hear and learn from you. Your experiences will benefit the whole open source ecosystem.
We've put together the following guidelines to help you figure out where you can best be helpful.
## Table of Contents
0. [Types of contributions we're looking for](#types-of-contributions-were-looking-for)
0. [Ground rules & expectations](#ground-rules--expectations)
0. [How to contribute](#how-to-contribute)
## Types of contributions we're looking for
We're still putting the finishing touches on the survey instrument and aren't quite ready to start collecting survey responses. [Sign up for updates](http://opensourcesurvey.org) if you'd like to be notified when the survey is available.
Right now we're looking for your help in two main areas:
0. If you're a researcher who's studied topics similar to the ones [we're interested in](./survey-topics.md), we'd love to hear from you about any existing survey instruments that explore these topic areas. There's [an issue](https://github.com/github/the-open-source-survey/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) in this repository for each topic area - please let us know about existing work there.
0. If you're active in an open source community that doesn't use GitHub as their primary platform for collaboration we'd love to hear from you. We want to reach _all_ open source communities with this survey and so if you think you might be able to help us reach our to your community email opensource@github.com.
## Ground rules & expectations
Before we get started, here are a few things we expect from you (and that you should expect from others):
* Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "what is important for open source." Try to listen to others rather than convince them that your way is correct.
* This survey 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 to contribute
If you'd like to contribute, start by searching through the [issues](https://github.com/github/the-open-source-survey/issues) and [pull requests](https://github.com/github/the-open-source-survey/pulls) to see whether someone else has raised a similar idea or question.
If you don't see your idea listed, and you think it fits into the goals of this survey, do one of the following:
* **If your contribution is minor,** such as a typo fix, you can make the change and open a pull request.
* **If your contribution is major,** such as a new article or case study, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

Просмотреть файл

@ -12,15 +12,6 @@ At GitHub our goal is to help everyone build better software. We believe open so
To build better software, then we need a software community where anyone, regardless of what they look like or where they come from, can participate. This survey will help us see how we, as a community, are doing.
## How you can help
We're still putting the finishing touches on the survey instrument and so aren't quite ready to start collecting survey responses. Right now we're looking for your help in two main areas:
0. If you're a researcher who's studied topics similar to the ones [we're interested in](https://github.com/github/the-open-source-survey/blob/master/survey-topics.md), we'd love to hear from you about any existing survey instruments that explore these topic areas. There's [an issue](https://github.com/github/the-open-source-survey/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) in this repository for each topic area - please let us know about existing work there.
0. If you're active in an open source community that doesn't use GitHub as their primary platform for collaboration we'd love to hear from you. We want to reach _all_ open source communities with this survey and so if you think you might be able to help us reach our to your community email opensource@github.com.
Finally, if you'd like to be notified of any updates about this project, please fill in your email address on the [survey website](http://opensourcesurvey.org).
## Open data
Open source is bigger than any company or community. The result of this survey will be an open data set for anyone to use and learn from.
@ -39,6 +30,8 @@ This isn't a solo effort for us, these awesome organizations have helped us desi
- [Open Source Initiative](https://opensource.org/)
- ...
Check out the [contributing guidelines](./CONTRIBUTING.md) if you want to get involved.
## Licenses
Content is released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/), which gives you permission to use content for almost any purpose but does not grant you any trademark permissions, so long as you note the license and give credit, such as follows: