From cd13d7025194395f932b205e3b96efd1dbee8227 Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Mon, 4 Dec 2017 18:48:17 -0800 Subject: [PATCH 1/3] Add `CONTRIBUTING.md` To foster an active and welcoming open source community, let's offer tips to first time contributors via the 'CONTRIBUTING.md' doc. This links to a Code of Conduct doc - a follow up commit will add the Code of Conduct. --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..1fa2e8905 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +CONTRIBUTING + +# Contributing to Mcrouter +We want to make contributing to this project as easy and transparent as +possible. + +## Code of Conduct +The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). + +## Pull Requests +We actively welcome your pull requests. + +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests. +3. If you've changed APIs, update the documentation. +4. Ensure the test suite passes. +5. Make sure your code lints. +6. If you haven't already, complete the Contributor License Agreement ("CLA"). + +## Contributor License Agreement ("CLA") +In order to accept your pull request, we need you to submit a CLA. You only need +to do this once to work on any of Facebook's open source projects. + +Complete your CLA here: + +## Issues +We use GitHub issues to track public bugs. Please ensure your description is +clear and has sufficient instructions to be able to reproduce the issue. + +Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe +disclosure of security bugs. In those cases, please go through the process +outlined on that page and do not file a public issue. + +## License +By contributing to Mcrouter, you agree that your contributions will be licensed +under the LICENSE file in the root directory of this source tree. From 093efcf6d747d1e6e98400ee58f566be18154b03 Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Tue, 5 Dec 2017 06:19:25 -0800 Subject: [PATCH 2/3] Add `CODE_OF_CONDUCT.md` In the past there was not info and support to add these docs to all Facebook Open Source projects. It's a useful measure that we can take now to create a healthy, welcoming open source community. :) **why make this change?:** Facebook Open Source provides a Code of Conduct statement for all projects to follow, to promote a welcoming and safe open source community. Exposing the COC via a separate markdown file is a standard being promoted by Github via the Community Profile in order to meet their Open Source Guide's recommended community standards. As you can see, adding this file will improve [the Mcrouter community profile](https://github.com/facebook/mcrouter/community) checklist and increase the visibility of our COC. **test plan:** Viewing it on my branch - (Flarnie will insert screenshots) **issue:** internal task t23481323 --- CODE_OF_CONDUCT.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..0a45f9bd5 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated. From c8f61c035c3f228393cabba2e8f20911508a781f Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Tue, 5 Dec 2017 06:22:53 -0800 Subject: [PATCH 3/3] fix typo --- CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fa2e8905..01f08d138 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,3 @@ -CONTRIBUTING - # Contributing to Mcrouter We want to make contributing to this project as easy and transparent as possible.