Skip to content

Commit 2947b77

Browse files
authored
Add CONTRIBUTING page (#360)
* Add CONTRIBUTING page * Add Gemfile examples --------- Co-authored-by: Andy Waite <[email protected]>
1 parent 8600f3b commit 2947b77

File tree

2 files changed

+34
-3
lines changed

2 files changed

+34
-3
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# CONTRIBUTING
2+
3+
Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ruby-lsp-rails. This project is
4+
intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
5+
[Contributor Covenant](https://github.com/Shopify/ruby-lsp-rails/blob/main/CODE_OF_CONDUCT.md) code of conduct.
6+
7+
# Developing on Ruby LSP
8+
9+
For general information about developing, refer to the to the [documentation](https://github.com/Shopify/ruby-lsp/blob/main/CONTRIBUTING.md#debugging-with-vs-code) for Ruby LSP itself.
10+
11+
### Manually testing a change
12+
13+
The repo includes a dummy Rails app in `test/dummy`. If you're developing a feature, you can add new code to it for testing.
14+
15+
To test with a real Rails application, you can add a Gemfile entry for `ruby-lsp-rails` and point it to your local checkout:
16+
17+
```ruby
18+
gem "ruby-lsp-rails", path: "../ruby-lsp-rails"
19+
```
20+
21+
Or to a branch in your fork:
22+
23+
```ruby
24+
gem "ruby-lsp-rails", github: "USERNAME/ruby-lsp-rails", branch: "your_branch"
25+
```
26+
27+
### Running the test suite
28+
29+
The test suite can be executed by running
30+
31+
```shell
32+
bin/rails test
33+
```

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,7 @@ When extension is stopped (e.g. by quitting the editor), the server instance is
3737
3838
## Contributing
3939

40-
Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ruby-lsp-rails. This project is
41-
intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
42-
[Contributor Covenant](https://github.com/Shopify/ruby-lsp-rails/blob/main/CODE_OF_CONDUCT.md) code of conduct.
40+
See [CONTRIBUTING.md](https://github.com/Shopify/ruby-lsp-rails/blob/main/CONTRIBUTING.md)
4341

4442
## License
4543

0 commit comments

Comments
 (0)