Skip to content

Commit 778669d

Browse files
committed
Update documentation
1 parent eaf2168 commit 778669d

2 files changed

Lines changed: 14 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ There are a couple ways you can help improve webmention-client-ruby:
88

99
## Getting Started
1010

11-
webmention-client-ruby is developed using Ruby 3.3.0 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
11+
webmention-client-ruby is developed using Ruby 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
1212

13-
Before making changes to webmention-client-ruby, you'll want to install Ruby 3.3.0. Using a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm) is recommended. Once you've installed Ruby 3.3.0 using your method of choice, install the project's gems by running:
13+
> [!TIP]
14+
> This project is configured with a [Dev Container](https://containers.dev) which includes everything you'd need to contribute to webmention-client-ruby. If you use a supported code editor or IDE, you're encouraged to use the existing Dev Container setup.
15+
16+
Before making changes to webmention-client-ruby, you'll want to install Ruby 3.4. Using a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm) is recommended. Once you've installed Ruby 3.4 using your method of choice, install the project's gems by running:
1417

1518
```sh
1619
bundle install
@@ -19,17 +22,17 @@ bundle install
1922
## Making Changes
2023

2124
1. Fork and clone the project's repo.
22-
1. Install development dependencies as outlined above.
23-
1. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
24-
1. _Write some code!_
25-
1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
26-
1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://chris.beams.io/posts/git-commit/) for tips on writing useful Git commit messages.)_
27-
1. Push the branch to your fork: `git push -u origin my-new-feature`.
28-
1. Create a new [Pull Request][pulls] and we'll review your changes.
25+
2. Install development dependencies as outlined above.
26+
3. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
27+
4. _Write some code!_
28+
5. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
29+
6. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://cbea.ms/git-commit/) for tips on writing useful Git commit messages.)_
30+
7. Push the branch to your fork: `git push -u origin my-new-feature`.
31+
8. Create a new [Pull Request][pulls] and we'll review your changes.
2932

3033
## Code Style
3134

32-
Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended installing the EditorConfig plugin for your editor of choice.
35+
Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](https://editorconfig.org) syntax. There are [plugins for a variety of editors](https://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended installing the EditorConfig plugin for your editor of choice.
3336

3437
Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.
3538

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
Before installing and using webmention-client-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 3.0 (or newer) installed. Using a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm) is recommended.
1919

20-
webmention-client-ruby is developed using Ruby 3.0.0 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
20+
webmention-client-ruby is developed using Ruby 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
2121

2222
## Installation
2323

0 commit comments

Comments
 (0)