summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGreg Houle <greg.houle@shopify.com>2018-08-18 05:52:45 -0400
committerGreg Houle <greg.houle@shopify.com>2018-08-21 00:18:11 -0400
commit54b9d6dd572a7877b360164ece6eaa852cef1ee3 (patch)
treee0325f749e17403ef75362e3df4188289a8b2983 /CONTRIBUTING.md
parent9b99c10b77ac24b7562b3b7786a52869ac2dafa7 (diff)
downloadpsych-54b9d6dd572a7877b360164ece6eaa852cef1ee3.tar.gz
Add a contribution file to help others contribute
Co-authored-by: Aaron Patterson <tenderlove@github.com> Co-authored-by: SHIBATA Hiroshi <hsbt@ruby-lang.org>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..869d801
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+## How to contribute to Psych
+
+Full details [here](https://bugs.ruby-lang.org/projects/ruby/wiki/HowToContribute)
+
+#### **Did you find a bug?**
+
+* **Do not open an issue if the bug is a security vulnerability
+ in Psych**, instead refer to our [security policy](https://www.ruby-lang.org/en/security/) and email [here](security@ruby-lang.org).
+
+* **Ensure the bug was not already reported** by searching on ruby-core, the ruby github repo and on Psych's github repo. More info [here](https://bugs.ruby-lang.org/projects/ruby/wiki/HowToReport)
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://bugs.ruby-lang.org/). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new GitHub pull request with the patch for small fixes. Anything larger look [here](https://bugs.ruby-lang.org/projects/ruby/wiki/HowToContribute); submit a Feature.
+
+* Ensure you clearly describe the problem and solution. Include the relevant ticket/issue number if applicable.
+
+Psych is a volunteer effort. We encourage you to pitch in and [join the team](https://github.com/ruby/psych/contributors)!
+
+Thanks! :heart: :heart: :heart:
+
+The Psych Team