Skip to content

Commit 98cac1a

Browse files
authored
Point people to redmine on ZJIT docs (ruby#15499)
Fix Shopify#900
1 parent abefd3e commit 98cac1a

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

doc/jit/zjit.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,38 @@ This project is open source and falls under the same license as CRuby.
1111
ZJIT may not be suitable for certain applications. It currently only supports macOS, Linux and BSD on x86-64 and arm64/aarch64 CPUs. ZJIT will use more memory than the Ruby interpreter because the JIT compiler needs to generate machine code in memory and maintain additional state information.
1212
You can change how much executable memory is allocated using [ZJIT's command-line options](rdoc-ref:@Command-Line+Options).
1313

14+
## Contributing
15+
16+
We welcome open source contributions. Feel free to open new issues to report
17+
bugs or just to ask questions. Suggestions on how to make this document more
18+
helpful for new contributors are most welcome.
19+
20+
Bug fixes and bug reports are very valuable to us. If you find a bug in ZJIT,
21+
it's very possible that nobody has reported it before, or that we don't have
22+
a good reproduction for it, so please open a ticket on [the official Ruby bug
23+
tracker][rubybugs] (or, if you don't want to make an account, [on
24+
Shopify/ruby][shopifyruby]) and provide as much information as you can about
25+
your configuration and a description of how you encountered the problem. List
26+
the commands you used to run ZJIT so that we can easily reproduce the issue on
27+
our end and investigate it. If you are able to produce a small program
28+
reproducing the error to help us track it down, that is very much appreciated
29+
as well.
30+
31+
[rubybugs]: https://bugs.ruby-lang.org/projects/ruby-master
32+
[shopifyruby]: https://github.com/Shopify/ruby/issues
33+
34+
If you would like to contribute a large patch to ZJIT, we suggest [chatting on
35+
Zulip][zulip] for a casual chat and then opening an issue on the [Shopify/ruby
36+
repository][shopifyruby] so that we can have a technical discussion. A common
37+
problem is that sometimes people submit large pull requests to open source
38+
projects without prior communication, and we have to reject them because the
39+
work they implemented does not fit within the design of the project. We want to
40+
save you time and frustration, so please reach out so we can have a productive
41+
discussion as to how you can contribute patches we will want to merge into
42+
ZJIT.
43+
44+
[zulip]: https://zjit.zulipchat.com/
45+
1446
## Build Instructions
1547

1648
Refer to [Building Ruby](rdoc-ref:contributing/building_ruby.md) for general build prerequists.

0 commit comments

Comments
 (0)