ruby-changes:71796
From: Jemma <ko1@a...>
Date: Wed, 11 May 2022 23:59:40 +0900 (JST)
Subject: [ruby-changes:71796] c00feffb46 (master): Improve documentation on contributing to Ruby
https://git.ruby-lang.org/ruby.git/commit/?id=c00feffb46 From c00feffb46ac646605adc277b5454e6b067e2d8a Mon Sep 17 00:00:00 2001 From: Jemma Issroff <jemmaissroff@g...> Date: Mon, 9 May 2022 11:45:50 -0400 Subject: Improve documentation on contributing to Ruby co-authored-by: Peter Zhu <peter@p...> co-authored-by: Stan Lo <stan001212@g...> --- .document | 1 - CONTRIBUTING.md | 6 +- README.md | 93 +------ doc/.document | 1 + doc/contributing.md | 10 + doc/contributing.rdoc | 402 ----------------------------- doc/contributing/building_ruby.md | 74 ++++++ doc/contributing/documentation_guide.md | 359 ++++++++++++++++++++++++++ doc/contributing/making_changes_to_ruby.md | 36 +++ doc/contributing/reporting_issues.md | 91 +++++++ doc/contributing/testing_ruby.md | 100 +++++++ doc/documentation_guide.rdoc | 327 ----------------------- doc/hacking.md | 104 -------- doc/make_cheatsheet.md | 124 --------- 14 files changed, 675 insertions(+), 1053 deletions(-) create mode 100644 doc/contributing.md delete mode 100644 doc/contributing.rdoc create mode 100644 doc/contributing/building_ruby.md create mode 100644 doc/contributing/documentation_guide.md create mode 100644 doc/contributing/making_changes_to_ruby.md create mode 100644 doc/contributing/reporting_issues.md create mode 100644 doc/contributing/testing_ruby.md delete mode 100644 doc/documentation_guide.rdoc delete mode 100644 doc/hacking.md delete mode 100644 doc/make_cheatsheet.md diff --git a/.document b/.document index 9cdd66f87a..5494bcc7fe 100644 --- a/.document +++ b/.document @@ -41,7 +41,6 @@ README.ja.md https://github.com/ruby/ruby/blob/trunk/.document#L41 COPYING COPYING.ja -CONTRIBUTING.md LEGAL diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7363c106a2..13df6087ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1 @@ -Please see the [official issue tracker], [doc/contributing.rdoc] and wiki [HowToContribute]. - -[official issue tracker]: https://bugs.ruby-lang.org -[doc/contributing.rdoc]: contributing.rdoc -[HowToContribute]: https://bugs.ruby-lang.org/projects/ruby/wiki/HowToContribute +See ["Contributing to Ruby"](https://docs.ruby-lang.org/en/master/contributing_md.html), which includes setup and build instructions. diff --git a/README.md b/README.md index a4a2ef1c91..0350ec3fb2 100644 --- a/README.md +++ b/README.md @@ -74,107 +74,20 @@ in the mail body (not subject) to the address [ruby-talk-request@r...]. https://github.com/ruby/ruby/blob/trunk/README.md#L74 [ruby-talk-request@r...]: mailto:ruby-talk-request@r...?subject=Join%20Ruby%20Mailing%20List&body=subscribe -## Requirements to build from repository - -1. GNU or BSD make -2. C99 compiler -3. autoconf 2.67 or higher -4. automake 1.15 or higher -5. bison 2.3 or higher -6. Ruby 2.2 or higher - -When building from a released version, only a C99 compiler and GNU or BSD make -is required. - -## How to compile and install - -1. If you want to use Microsoft Visual C++ to compile Ruby, read - [win32/README.win32](rdoc-ref:win32/README.win32) instead of this document. - -2. Run `./autogen.sh` to generate configure, when you build the source checked - out from the Git repository. - -3. Run `./configure`, which will generate `config.h` and `Makefile`. - - Some C compiler flags may be added by default depending on your - environment. Specify `optflags=..` and `warnflags=..` as necessary to - override them. - -4. Edit `include/ruby/defines.h` if you need. Usually this step will not be needed. - -5. Optional: Remove comment mark(`#`) before the module names from `ext/Setup`. - - This step is only necessary if you want to link modules statically. - - If you don't want to compile dynamic extensions (probably on architectures - which do not allow dynamic loading), remove comment mark from the line - "`#option nodynamic`" in `ext/Setup`. - - Usually this step will not be needed. - -6. Run `make`. - - * On Mac, set RUBY\_CODESIGN environment variable with a signing identity. - It uses the identity to sign `ruby` binary. See also codesign(1). - -7. Optionally, run '`make check`' to check whether the compiled Ruby - interpreter works well. If you see the message "`check succeeded`", your - Ruby works as it should (hopefully). - -8. Run '`make install`'. - - This command will create the following directories and install files into - them. - - * `${DESTDIR}${prefix}/bin` - * `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}` - * `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}` - * `${DESTDIR}${prefix}/lib` - * `${DESTDIR}${prefix}/lib/ruby` - * `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}` - * `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}` - * `${DESTDIR}${prefix}/lib/ruby/site_ruby` - * `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}` - * `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}` - * `${DESTDIR}${prefix}/lib/ruby/vendor_ruby` - * `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}` - * `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}` - * `${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}` - * `${DESTDIR}${prefix}/share/man/man1` - * `${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system` - - If Ruby's API version is '*x.y.z*', the `${MAJOR}` is '*x*', the - `${MINOR}` is '*y*', and the `${TEENY}` is '*z*'. - - **NOTE**: teeny of the API version may be different from one of Ruby's - program version - - You may have to be a super user to install Ruby. - -If you fail to compile Ruby, please send the detailed error report with the -error log and machine/OS type, to help others. - -Some extension libraries may not get compiled because of lack of necessary -external libraries and/or headers. You will need to run '`make distclean-ext`' -to remove old configuration after installing them in such a case. - ## Copying See the file [COPYING](rdoc-ref:COPYING). ## Feedback -Questions about the Ruby language can be asked on the [Ruby-Talk] mailing list +Questions about the Ruby language can be asked on the [Ruby-Talk](https://www.ruby-lang.org/en/community/mailing-lists) mailing list or on websites like https://stackoverflow.com. -Bugs should be reported at https://bugs.ruby-lang.org. Read [HowToReport] for more information. - -[Ruby-Talk]: https://www.ruby-lang.org/en/community/mailing-lists -[HowToReport]: https://bugs.ruby-lang.org/projects/ruby/wiki/HowToReport +Bugs should be reported at https://bugs.ruby-lang.org. Read ["Reporting Issues"](https://docs.ruby-lang.org/en/master/reporting_issues_md.html) for more information. ## Contributing -See the file [CONTRIBUTING.md](rdoc-ref:CONTRIBUTING) +See ["Contributing to Ruby"](https://docs.ruby-lang.org/en/master/contributing_md.html), which includes setup and build instructions. ## The Author diff --git a/doc/.document b/doc/.document index 84c1be6e5e..03d332367c 100644 --- a/doc/.document +++ b/doc/.document @@ -1,6 +1,7 @@ https://github.com/ruby/ruby/blob/trunk/doc/.document#L1 *.md *.rb *.rdoc +contributing NEWS syntax optparse 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 @@ https://github.com/ruby/ruby/blob/trunk/doc/contributing.md#L1 +# 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 diff --git a/doc/contributing.rdoc b/doc/contributing.rdoc deleted file mode 100644 index 00875d1428..0000000000 --- a/doc/contributing.rdoc +++ /dev/null @@ -1,402 +0,0 @@ https://github.com/ruby/ruby/blob/trunk/doc/contributing.md#L0 -= Contributing to Ruby - -Ruby has a vast and friendly community with hundreds of people contributing to -a thriving open-source ecosystem. This guide is designed to cover ways for -participating in the development of CRuby. - -There are plenty of ways for you to help even if you're not ready to write -code or documentation. You can help by reporting issues, testing patches, and -trying out beta releases with your applications. - -== How To Report - -If you've encountered a bug in Ruby please report it to the redmine issue -tracker available at {bugs.ruby-lang.org}[https://bugs.ruby-lang.org/]. Do not -report security vulnerabilities here, there is a {separate -channel}[rdoc-label:label-Reporting+Security+Issues] for them. - -There are a few simple steps you should follow in order to receive feedback -on your ticket. - -* If you haven't already, - {sign up for an account}[https://bugs.ruby-lang.org/account/register] on the - bug tracker. -* Try the latest version. - - If you aren't already using the latest version, try installing a newer - stable release. See - {Downloading Ruby}[https://www.ruby-lang.org/en/downloads/]. -* Look to see if anyone already reported your issue (... truncated) -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/