mirror of
https://github.com/ruby/ruby.git
synced 2025-08-15 05:29:10 +02:00
[DOC] Tweaks for docs about contributing (#13012)
This commit is contained in:
parent
cdb1bf1e53
commit
765918d283
Notes:
git
2025-03-31 18:48:40 +00:00
Merged-By: peterzhu2118 <peter@peterzhu.ca>
3 changed files with 36 additions and 13 deletions
|
@ -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
|
35
doc/contributing/contributing.md
Normal file
35
doc/contributing/contributing.md
Normal file
|
@ -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).
|
|
@ -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)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue