Skip to content

Commit bcc8490

Browse files
committed
Add notes about testing and development to CONTRIBUTING.md
1 parent cd3a312 commit bcc8490

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,31 @@ When contributing code that changes behavior or fixes bugs, please include unit
4949
tests to cover the new behavior or to provide regression testing for bugs.
5050
Also, treat the unit tests as documentation --- make sure they are clean,
5151
clear, and concise, and well organized.
52+
53+
## Testing and Development
54+
55+
- This project uses RSpec to both document and test behavior. Please structure
56+
your tests help someone understand what is being tested.
57+
- It also uses rubocop to autoformat and lint the project. Run it locally
58+
before committing.
59+
60+
You can run both the test suite and the linter with the following commands:
61+
62+
```sh
63+
# install/update dependencies
64+
bundle
65+
66+
# run the test suite and linter
67+
bundle exec rake
68+
69+
# have the linter apply all safe fixes (eg, autoformatting)
70+
bundle exec rake rubocop:autocorrect
71+
```
72+
73+
## Release Process
74+
75+
1. Update CHANGELOG.md and lib/recursive_open_struct/version.rb
76+
2. Run `bundle exec rake update_authors`
77+
3. Make a version release commit
78+
4. Run the release task (it will tag, build, push code, push package):
79+
`bundle exec rake release`

0 commit comments

Comments
 (0)