summaryrefslogtreecommitdiff
path: root/doc/contributing
AgeCommit message (Collapse)Author
2023-12-25Typofix under doc directoryHiroshi SHIBATA
2023-12-02[DOC] More on What's Here (#9099)Burdette Lamar
* More on What's Here * More on What's Here
2023-11-23Add recommendations on link formatting in documentationBurdette Lamar
2023-11-06[DOC] Use a relative link like other linksTakashi Kokubun
following up on https://github.com/ruby/ruby/pull/8832
2023-11-06Updated building_ruby.md to include reference for building on WindowsJorandeBoer
Looking at building_ruby.md it is unclear that you are able to build Ruby on Windows. To fix that a reference has been added to the windows.md file.
2023-10-20[DOC] `configure -C` tipsNobuyoshi Nakada
2023-10-20[DOC] Improve docs for how to generate documentationMatheus Richard
It might not be obvious how to get the build directory and the Makefile set up.
2023-10-14[DOC] testing_ruby.md: Add spec/ for the explanation of the `make check`.Jun Aruga
2023-10-14[DOC] testing_ruby.md: Remove the command prompt '$ ` aligning with other parts.Jun Aruga
Remove the command prompt '$ ` aligning with other parts in the document.
2023-10-09testing_ruby.md: Document running test suites on s390x CPU architecture [ci ↵Jun Aruga
skip] (#8589)
2023-09-24[DOC] Correction for doc guide + TOC fix in File (#8505)Burdette Lamar
2023-08-26Add documentation regarding how to build Ruby for debugging. (#8290)Samuel Williams
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> Notes: Merged-By: ioquatix <samuel@codeotaku.com>
2023-08-23[DOC] Adding font usage to doc guide (#8255)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-08-12[DOC] Update to use `SPECOPTS` instead of `MSPECOPT`Nobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/8210
2023-08-11[DOC] Don't suppress autolinks (#8207)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-07-14[Doc] Make build instructions easier to copy-and-pastejinroq
Notes: Merged: https://github.com/ruby/ruby/pull/8077 Merged-By: XrXr
2023-06-28[DOC] Fixes for link fragments (#7981)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-06-26[DOC] Nested ordered lists need more indentsNobuyoshi Nakada
2023-06-25Fix broken linksBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/7979
2023-05-26testing_ruby.md: Update `make test-all` tips [ci skip]Jun Aruga
Notes: Merged: https://github.com/ruby/ruby/pull/7861
2023-05-12Use Lrama LALR parser generator instead of Bisonv3_3_0_preview1Yuichiro Kaneko
https://bugs.ruby-lang.org/issues/19637 Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> Notes: Merged: https://github.com/ruby/ruby/pull/7798 Merged-By: yui-knk <spiketeika@gmail.com>
2023-05-10readline or libedit is no longer required to build rubyHiroshi SHIBATA
2023-05-09Fix broken link to maintainers pageJemma Issroff
Notes: Merged: https://github.com/ruby/ruby/pull/7792
2023-04-05Add BIN as an entry in the glossary (#7667)Adam Hess
I initially thought this macro is referencing binary, not basic instruction name Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2023-03-10Bump the required BASERUBY version to 2.5 (#7504)Takashi Kokubun
[Misc #16671] I'd like to bump it to 2.7 to use pattern matching in tool/mk_builtin_loader.rb. However, I experienced a few blockers. 2.5 seems like the closest version that is easy enough to use on CIs, so let me bump the version to it as an intermediate step for it. I want to use &. and <<~ in 2.3 too. Known blockers: * AppVeyor Visual Studio 2015 doesn't have Ruby 2.7. You'd need to bump the version to Visual Studio 2019. * GitHub Actions windows-2019 doesn't have Ruby 2.7 either. You can use ruby/setup-ruby, but configure doesn't seem to work with it. * For ruby/ruby-ci-imaage, bionic doesn't have Ruby 2.7. I tried using ruby-build to build Ruby 2.7 from package, but the build on its CI seems to somehow loop forever when I do that. So I gave it up for now. We might want to wait until bionic becomes EOL. Note: * AppVeyor Visual Studio 2015 has Ruby <= 2.6.3 https://www.appveyor.com/docs/windows-images-software/#ruby * GitHub Actions windows-2019 uses Ruby 2.5.9 https://github.com/actions/runner-images/blob/main/images/win/Windows2019-Readme.md Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2023-03-03[DOC] Add missing word to documentation_guide.mdEzra-Shimon Rosenfeld
Notes: Merged: https://github.com/ruby/ruby/pull/7414
2023-02-19Mention when it is appropriate to document aliases in call-seqJeremy Evans
2023-02-19[DOC] Change to handling of aliases (#7340)Burdette Lamar
Change to handling of aliases Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2023-02-09Add internals glossaryAaron Patterson
I started a glossary to help new contributors navigate the internals of CRuby, and I think we should maintain it in ruby/ruby Notes: Merged: https://github.com/ruby/ruby/pull/7280
2023-02-08[DOC] Refine/fix doc/contributing/building_ruby.md [ci skip]Nobuyoshi Nakada
* Separate dependencies for RubyGems * Add reasons of optional libraries * Add a note for gperf and fix the required version
2023-02-07Fix confusing "Benoit Daloze
2023-02-07Mentioned gmp at requirementsHiroshi SHIBATA
2023-02-07Added tarball instruction to building_ruby.mdHiroshi SHIBATA
2023-01-20OpenSSL, libyaml and zlib is always required to build. see test/test_extlibs.rbHiroshi SHIBATA
2023-01-20Added supported versions to OpenSSL and libyamlHiroshi SHIBATA
2023-01-20Added version policy of BASERUBYHiroshi SHIBATA
[Misc #16671]
2023-01-20Separate dependencies section from quick startHiroshi SHIBATA
2023-01-20fixed wrong version of baserubyHiroshi SHIBATA
2023-01-06[DOC] Mention `configure` options earlier, not after failureNobuyoshi Nakada
The command line arguments to `configure` are stored in `rbconfig.rb`. Usually these are just useless but harmless after the installation, however could affect unexpectedly when updating default gems. Notes: Merged: https://github.com/ruby/ruby/pull/7076
2023-01-06[DOC] Specify `shell` format to shell commandsNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/7076
2022-11-21YJIT: Lower the required Rust version from 1.58.1 to 1.58.0 (#6780)Takashi Kokubun
Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2022-11-10Update required Bison version in building_ruby.md [ci skip]yui-knk
See [Feature #19068] for the context. Notes: Merged: https://github.com/ruby/ruby/pull/6705
2022-11-08[doc] Clarify how to build OpenSSL on macOSMatt Valentine-House
Notes: Merged: https://github.com/ruby/ruby/pull/6692
2022-11-07[DOC] Properly number the list in building_ruby.mdPeter Zhu
2022-11-07[DOC] Improve building_ruby.mdPeter Zhu
2022-11-03Update configure command in building_ruby.mdPeter Zhu
Readers didn't realize that you can use --prefix with --disable-install-doc.
2022-10-27Update docs wrt YJIT limitations and building YJIT (#6641)Maxime Chevalier-Boisvert
* Update docs wrt YJIT limitations and building YJIT * Update building_ruby.md Fix relative link Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2022-10-24[DOC] Add note about method names (#6620)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-06Adapt doc guide to new GFM features (#6504)Burdette Lamar
* Adapt doc guide to new GFM features * Adapt doc guide to new GFM features Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-04[DOC] Adding remarks about HTML and tables (#6485)Burdette Lamar
* Adding remarks about HTML and tables Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-19 08:50:00 +0000