diff options
| -rw-r--r-- | CODE_OF_CONDUCT.md | 40 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 49 |
2 files changed, 89 insertions, 0 deletions
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..336f0e6 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,40 @@ +# Code of Conduct + +At Pinterest, we work hard to ensure that our work environment is welcoming +and inclusive to as many people as possible. We are committed to creating this +environment for everyone involved in our open source projects as well. We +welcome all participants regardless of ability, age, ethnicity, identified +gender, religion (or lack there of), sexual orientation and socioeconomic +status. + +This code of conduct details our expectations for upholding these values. + +## Good behavior + +We expect members of our community to exhibit good behavior including (but of +course not limited to): + +- Using intentional and empathetic language. +- Focusing on resolving instead of escalating conflict. +- Providing constructive feedback. + +## Unacceptable behavior + +Some examples of unacceptable behavior (again, this is not an exhaustive +list): + +- Harassment, publicly or in private. +- Trolling. +- Sexual advances (this isn’t the place for it). +- Publishing other’s personal information. +- Any behavior which would be deemed unacceptable in a professional environment. + +## Recourse + +If you are witness to or the target of unacceptable behavior, it should be +reported to Pinterest at opensource-policy@pinterest.com. All reporters will +be kept confidential and an appropriate response for each incident will be +evaluated. + +If the pymemcache maintainers do not uphold and enforce this code of conduct +in good faith, community leadership will hold them accountable. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..de04910 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing + +First off, thanks for taking the time to contribute! This guide will answer +some common questions about how this project works. + +While this is a Pinterest open source project, we welcome contributions from +everyone. Regular outside contributors can become project maintainers. + +## Code of Conduct + +Please read and understand our [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). We +work hard to ensure that our projects are welcoming and inclusive to as many +people as possible. + +## Making Changes + +1. Fork this repository to your own account +2. Make your changes and verify that tests pass +3. Commit your work and push to a new branch on your fork +4. Submit a pull request +5. Participate in the code review process by responding to feedback + +Once there is agreement that the code is in good shape, one of the project's +maintainers will merge your contribution. + +To increase the chances that your pull request will be accepted: + +- Follow the coding style +- Write tests for your changes +- Write a good commit message + +## Coding Style + +This project follows [PEP 8](https://www.python.org/dev/peps/pep-0008/) +conventions and is linted using [flake8](http://flake8.pycqa.org/). + +## Testing + +The tests use [pytest](https://docs.pytest.org/) and can be run using `tox` or +directly via: + + py.test pymemcache/test/ + +Note that the tests require a local memcached instance. + +## License + +By contributing to this project, you agree that your contributions will be +licensed under its [Apache 2 license](LICENSE). |