summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2025-03-31 13:48:23 -0500
committerGitHub <noreply@github.com>2025-03-31 14:48:23 -0400
commit765918d28317be34ec0c688a7742847801804e36 (patch)
tree46bb15316e82a13e643acc6c7940da94b8941fe8
parentcdb1bf1e53a8cbb67d273f5b09c3bec775f2c3eb (diff)
[DOC] Tweaks for docs about contributing (#13012)
Notes
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
-rw-r--r--doc/contributing.md12
-rw-r--r--doc/contributing/contributing.md35
-rw-r--r--doc/index.md2
3 files changed, 36 insertions, 13 deletions
diff --git a/doc/contributing.md b/doc/contributing.md
deleted file mode 100644
index a6c63de9b2..0000000000
--- a/doc/contributing.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# 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 standard libraries](contributing/making_changes_to_stdlibs.md): How to build, test, and contribute to Ruby standard libraries
-* [Making changes to Ruby documentation](contributing/documentation_guide.md): How to make changes to Ruby documentation
-* [Benchmarking Ruby](https://github.com/ruby/ruby/tree/master/benchmark#make-benchmark): How to benchmark Ruby
diff --git a/doc/contributing/contributing.md b/doc/contributing/contributing.md
new file mode 100644
index 0000000000..a2ed00ab90
--- /dev/null
+++ b/doc/contributing/contributing.md
@@ -0,0 +1,35 @@
+# Contributing to Ruby
+
+## Ruby Issues
+
+To report an issue in the Ruby core:
+
+* [Report issues](reporting_issues.md).
+
+## Ruby Core
+
+To contribute to the Ruby core functionality,
+you'll need initially to:
+
+* [Build Ruby](building_ruby.md) on your system.
+* [Test Ruby](testing_ruby.md), to make sure the build is correct.
+
+Then:
+
+* [Make changes to Ruby](making_changes_to_ruby.md).
+
+And possibly:
+
+* [Benchmark Ruby](https://github.com/ruby/ruby/tree/master/benchmark#make-benchmark).
+
+## Ruby Documentation
+
+To contribute to the Ruby core documentation, see:
+
+* [Making changes to the Ruby documentation](documentation_guide.md).
+
+## Ruby Standard Library
+
+To contribute to the Ruby Standard Library, see:
+
+* [Making changes to the Ruby Standard Library](making_changes_to_stdlibs.md).
diff --git a/doc/index.md b/doc/index.md
index 1dfe045042..596825a19c 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -51,7 +51,7 @@ Use the following links to access the comprehensive set of libraries included wi
Get involved with the Ruby community:
-- [Contribution Guide](rdoc-ref:contributing.md)
+- [Contribution Guide](rdoc-ref:contributing/contributing.md)
- [Documentation Guide](rdoc-ref:contributing/documentation_guide.md)
- [Reporting Issues](rdoc-ref:contributing/reporting_issues.md)
- [Building Ruby](rdoc-ref:contributing/building_ruby.md)