From dcee68512583de521786ffe5c2b573a6542f4f1a Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Sun, 26 Nov 2017 16:36:39 -0800 Subject: [PATCH 1/3] Add `CONTRIBUTING.md` Adding instructions for first time contributors fosters a healthy, welcoming Open Source Community. Even though this project does not seem very active, adding this document supports the Facebook Open Source Community as a whole. This links to a Code of Conduct - a follow up commit will add that document. --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..51220ef --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contributing to Open Graph Protocol +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 Open Graph Protocol, you agree that your contributions will be licensed +under the LICENSE file in the root directory of this source tree. From 653236ae59c456f05ab54420b50c3eca8030fdc8 Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Sun, 26 Nov 2017 16:38:12 -0800 Subject: [PATCH 2/3] Add `CODE_OF_CONDUCT.md` In the past Facebook didn't promote including a Code of Conduct when creating new projects, and many projects skipped this important document. Let's fix it. Even for this project, which does not seem super active, it can be useful to have a Code of Conduct. :) **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 Open Graph Protocol community profile](https://github.com/facebook/open-graph-protocol/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 0000000..0a45f9b --- /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 eb66afddba636530d66cd1c8ab63bb48ab32fec1 Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Sun, 26 Nov 2017 16:39:50 -0800 Subject: [PATCH 3/3] Link to `CONTRIBUTING.md` in `README.md` The `README.md` is pretty sparse, so thought it made sense to link to `CONTRIBUTING.md` here. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 80e2798..7123c8c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ The files used for hosting http://ogp.me/ -If you want to contribute, feel free to send pull requests and discuss any issues in the [Facebook Group](https://www.facebook.com/groups/opengraph/) \ No newline at end of file +If you want to contribute, feel free to send pull requests and discuss any issues in the [Facebook Group](https://www.facebook.com/groups/opengraph/) + +You can also find more details about contributing in the [`CONTRIBUTING.md`](CONTRIBUTING.md).