Skip to content

Commit 1d42034

Browse files
authored
chore(README): enhance development instructions (#14)
1 parent 4fdf4e4 commit 1d42034

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,29 @@ Now the test suite can be run from the project root using
190190
bundle exec rspec
191191
```
192192

193+
### Using a Development Version
194+
195+
Your changes can be tested manually by making one of the following additions to an App's Gemfile:
196+
197+
For using a local version:
198+
```ruby
199+
gem "sn_filterable", path: "path/to/gem/sn_filterable"
200+
```
201+
202+
For using a GitHub branch:
203+
```ruby
204+
gem "sn_filterable", git: "https://github.com/ibm-skills-network/sn_filterable.git", branch: "defaults_to_main"
205+
```
206+
207+
193208
## Contributing
194209

210+
Once you have made your updates to the codebase do the following to ensure a smooth merge:
211+
212+
1. Update `lib/sn_filterable/version.rb` to follow [Semantic Versioning](https://semver.org)
213+
214+
2. Run `bundle` to update the `Gemfile.lock` with your new version
215+
195216
Bug reports and pull requests are welcome on [GitHub](https://github.com/ibm-skills-network/sn_filterable).
196217

197218
## License

0 commit comments

Comments
 (0)