Skip to content

Move to CONTRIBUTING.md #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Move to CONTRIBUTING.md #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d33b98c
Move to `CONTRIBUTING.md` [ci skip]
sue445 Jul 30, 2024
f0c8068
Tweak doc [ci skip]
sue445 Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contribution Guide
## Add wrapper function for C
### 1. Generate skeleton
Run `ruby _scripts/dump_ruby_c_functions.rb`

Executing [`ruby _scripts/dump_ruby_c_functions.rb`](./_scripts/dump_ruby_c_functions.rb) will generate Go source code under `_scripts/dist/` based on `ruby.h`

In many cases there is an error on the last `go fmt`, but it's not a problem :sweat_smile:

### 2. Move function to top directory
Modify some of the auto-generated functions and add them to the ruby package in the top directory

### 3. Add a test that calls the added function
There is a dummy gem for this wrapper in [testdata/dummy/](testdata/dummy/).

Refer to following and add test code to call the added wrapper function.

* [testdata/dummy/ext/dummy/dummy.go](testdata/dummy/ext/dummy/dummy.go)
* [testdata/dummy/sig/dummy.rbs](testdata/dummy/sig/dummy.rbs)
* [testdata/dummy/spec/dummy_spec.rb](testdata/dummy/spec/dummy_spec.rb)

### 4. Run test
Run `rake ruby:build_dummy`.

### 5. Check coverage
[Coverage](README.md#coverage) lists Ruby's C functions, so check the functions you have added. (if there is no entry, add it)

### 6. Send patch
27 changes: 1 addition & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,32 +14,7 @@ Run `rake ruby:build_dummy`. (`bundle exec` is not required)
See `rake -T` for more tasks.

### Add wrapper function for C
#### 1. Generate skeleton
Run `ruby _scripts/dump_ruby_c_functions.rb`

Executing [`ruby ./_scripts/dump_ruby_c_functions.rb`](./_scripts/dump_ruby_c_functions.rb) will generate Go source code under `_scripts/dist/` based on `ruby.h`

In many cases there is an error on the last `go fmt`, but it's not a problem :sweat_smile:

#### 2. Move function to top directory
Modify some of the auto-generated functions and add them to the ruby package in the top directory

#### 3. Add a test that calls the added function
There is a dummy gem for this wrapper in [testdata/dummy/](testdata/dummy/).

Refer to following and add test code to call the added wrapper function.

* [testdata/dummy/ext/dummy/dummy.go](testdata/dummy/ext/dummy/dummy.go)
* [testdata/dummy/sig/dummy.rbs](testdata/dummy/sig/dummy.rbs)
* [testdata/dummy/spec/dummy_spec.rb](testdata/dummy/spec/dummy_spec.rb)

#### 4. Run test
Run `rake ruby:build_dummy`.

#### 5. Check coverage
[Coverage](#coverage) lists Ruby's C functions, so check the functions you have added. (if there is no entry, add it)

#### 6. Send patch
See [CONTRIBUTING.md](CONTRIBUTING.md)

### See `godoc` in local
```bash
Expand Down