summaryrefslogtreecommitdiff
path: root/doc/contributing.md
diff options
context:
space:
mode:
authorJemma Issroff <jemmaissroff@gmail.com>2022-05-09 11:45:50 -0400
committerPeter Zhu <peter@peterzhu.ca>2022-05-11 10:59:24 -0400
commitc00feffb46ac646605adc277b5454e6b067e2d8a (patch)
tree5dc1cd26ca18b1bc0f6a48a71b91a67a6c778d43 /doc/contributing.md
parentbecafe1efb7bf8bf5a324a6005b24e133c0f69a8 (diff)
Improve documentation on contributing to Ruby
co-authored-by: Peter Zhu <peter@peterzhu.ca> co-authored-by: Stan Lo <stan001212@gmail.com>
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/5899
Diffstat (limited to 'doc/contributing.md')
-rw-r--r--doc/contributing.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/contributing.md b/doc/contributing.md
new file mode 100644
index 0000000000..1f53e6f56e
--- /dev/null
+++ b/doc/contributing.md
@@ -0,0 +1,10 @@
+# Contributing to Ruby
+
+This guide outlines ways to get started with contributing to Ruby:
+
+* [Reporting issues](contributing/reporting_issues.md): How to report issues, how to request features, and how backporting works
+* [Building Ruby](contributing/building_ruby.md): How to build Ruby on your local machine for development
+* [Testing Ruby](contributing/testing_ruby.md): How to test Ruby on your local machine once you've built it
+* [Making changes to Ruby](contributing/making_changes_to_ruby.md): How to submit pull requests
+ to change Ruby's documentation, code, test suite, or standard libraries
+* [Making changes to Ruby documentation](contributing/documentation_guide.md): How to make changes to Ruby documentation \ No newline at end of file