Skip to content

Commit c00feff

Browse files
jemmaissroffpeterzhu2118st0012
committedMay 11, 2022
Improve documentation on contributing to Ruby
co-authored-by: Peter Zhu <peter@peterzhu.ca> co-authored-by: Stan Lo <stan001212@gmail.com>
1 parent becafe1 commit c00feff

13 files changed

+442
-820
lines changed
 

‎.document

-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ README.ja.md
4141

4242
COPYING
4343
COPYING.ja
44-
CONTRIBUTING.md
4544

4645
LEGAL
4746

‎CONTRIBUTING.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
1-
Please see the [official issue tracker], [doc/contributing.rdoc] and wiki [HowToContribute].
2-
3-
[official issue tracker]: https://bugs.ruby-lang.org
4-
[doc/contributing.rdoc]: contributing.rdoc
5-
[HowToContribute]: https://bugs.ruby-lang.org/projects/ruby/wiki/HowToContribute
1+
See ["Contributing to Ruby"](https://docs.ruby-lang.org/en/master/contributing_md.html), which includes setup and build instructions.

‎README.md

+3-90
Original file line numberDiff line numberDiff line change
@@ -74,107 +74,20 @@ in the mail body (not subject) to the address [ruby-talk-request@ruby-lang.org].
7474

7575
[ruby-talk-request@ruby-lang.org]: mailto:ruby-talk-request@ruby-lang.org?subject=Join%20Ruby%20Mailing%20List&body=subscribe
7676

77-
## Requirements to build from repository
78-
79-
1. GNU or BSD make
80-
2. C99 compiler
81-
3. autoconf 2.67 or higher
82-
4. automake 1.15 or higher
83-
5. bison 2.3 or higher
84-
6. Ruby 2.2 or higher
85-
86-
When building from a released version, only a C99 compiler and GNU or BSD make
87-
is required.
88-
89-
## How to compile and install
90-
91-
1. If you want to use Microsoft Visual C++ to compile Ruby, read
92-
[win32/README.win32](rdoc-ref:win32/README.win32) instead of this document.
93-
94-
2. Run `./autogen.sh` to generate configure, when you build the source checked
95-
out from the Git repository.
96-
97-
3. Run `./configure`, which will generate `config.h` and `Makefile`.
98-
99-
Some C compiler flags may be added by default depending on your
100-
environment. Specify `optflags=..` and `warnflags=..` as necessary to
101-
override them.
102-
103-
4. Edit `include/ruby/defines.h` if you need. Usually this step will not be needed.
104-
105-
5. Optional: Remove comment mark(`#`) before the module names from `ext/Setup`.
106-
107-
This step is only necessary if you want to link modules statically.
108-
109-
If you don't want to compile dynamic extensions (probably on architectures
110-
which do not allow dynamic loading), remove comment mark from the line
111-
"`#option nodynamic`" in `ext/Setup`.
112-
113-
Usually this step will not be needed.
114-
115-
6. Run `make`.
116-
117-
* On Mac, set RUBY\_CODESIGN environment variable with a signing identity.
118-
It uses the identity to sign `ruby` binary. See also codesign(1).
119-
120-
7. Optionally, run '`make check`' to check whether the compiled Ruby
121-
interpreter works well. If you see the message "`check succeeded`", your
122-
Ruby works as it should (hopefully).
123-
124-
8. Run '`make install`'.
125-
126-
This command will create the following directories and install files into
127-
them.
128-
129-
* `${DESTDIR}${prefix}/bin`
130-
* `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}`
131-
* `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
132-
* `${DESTDIR}${prefix}/lib`
133-
* `${DESTDIR}${prefix}/lib/ruby`
134-
* `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}`
135-
* `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
136-
* `${DESTDIR}${prefix}/lib/ruby/site_ruby`
137-
* `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}`
138-
* `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
139-
* `${DESTDIR}${prefix}/lib/ruby/vendor_ruby`
140-
* `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}`
141-
* `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
142-
* `${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}`
143-
* `${DESTDIR}${prefix}/share/man/man1`
144-
* `${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system`
145-
146-
If Ruby's API version is '*x.y.z*', the `${MAJOR}` is '*x*', the
147-
`${MINOR}` is '*y*', and the `${TEENY}` is '*z*'.
148-
149-
**NOTE**: teeny of the API version may be different from one of Ruby's
150-
program version
151-
152-
You may have to be a super user to install Ruby.
153-
154-
If you fail to compile Ruby, please send the detailed error report with the
155-
error log and machine/OS type, to help others.
156-
157-
Some extension libraries may not get compiled because of lack of necessary
158-
external libraries and/or headers. You will need to run '`make distclean-ext`'
159-
to remove old configuration after installing them in such a case.
160-
16177
## Copying
16278

16379
See the file [COPYING](rdoc-ref:COPYING).
16480

16581
## Feedback
16682

167-
Questions about the Ruby language can be asked on the [Ruby-Talk] mailing list
83+
Questions about the Ruby language can be asked on the [Ruby-Talk](https://www.ruby-lang.org/en/community/mailing-lists) mailing list
16884
or on websites like https://stackoverflow.com.
16985

170-
Bugs should be reported at https://bugs.ruby-lang.org. Read [HowToReport] for more information.
171-
172-
[Ruby-Talk]: https://www.ruby-lang.org/en/community/mailing-lists
173-
[HowToReport]: https://bugs.ruby-lang.org/projects/ruby/wiki/HowToReport
86+
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.
17487

17588
## Contributing
17689

177-
See the file [CONTRIBUTING.md](rdoc-ref:CONTRIBUTING)
90+
See ["Contributing to Ruby"](https://docs.ruby-lang.org/en/master/contributing_md.html), which includes setup and build instructions.
17891

17992
## The Author
18093

‎doc/.document

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
*.md
22
*.rb
33
*.rdoc
4+
contributing
45
NEWS
56
syntax
67
optparse

‎doc/contributing.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Contributing to Ruby
2+
3+
This guide outlines ways to get started with contributing to Ruby:
4+
5+
* [Reporting issues](contributing/reporting_issues.md): How to report issues, how to request features, and how backporting works
6+
* [Building Ruby](contributing/building_ruby.md): How to build Ruby on your local machine for development
7+
* [Testing Ruby](contributing/testing_ruby.md): How to test Ruby on your local machine once you've built it
8+
* [Making changes to Ruby](contributing/making_changes_to_ruby.md): How to submit pull requests
9+
to change Ruby's documentation, code, test suite, or standard libraries
10+
* [Making changes to Ruby documentation](contributing/documentation_guide.md): How to make changes to Ruby documentation

0 commit comments

Comments
 (0)
Please sign in to comment.