Skip to content

Commit

Permalink
Improve the contributing guideline (#756)
Browse files Browse the repository at this point in the history
  • Loading branch information
st0012 authored Nov 10, 2023
1 parent 1dec270 commit 1985701
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 12 deletions.
12 changes: 0 additions & 12 deletions CONTRIBUTING.md

This file was deleted.

24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,30 @@ To install this gem onto your local machine, run `bundle exec rake install`. To

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/irb.

### Set up the environment

1. Fork the project to your GithHub account
2. Clone the fork with `git clone [email protected]:[your_username]/irb.git`
3. Run `bundle install`
4. Run `bundle exec rake` to make sure tests pass locally

### Run integration tests

If your changes affect component rendering, such as the autocompletion's dialog/dropdown, you may need to run IRB's integration tests, known as `yamatanarroroti`.

Before running these tests, ensure that you have `libvterm` installed. If you're using Homebrew, you can install it by running:

```bash
brew install libvterm
```

After installing `libvterm`, you can run the integration tests using the following commands:

```bash
WITH_VTERM=1 bundle install
WITH_VTERM=1 bundle exec rake test test_yamatanooroti
```

## Releasing

```
Expand Down

0 comments on commit 1985701

Please sign in to comment.