Skip to content

Commit 2a23b0f

Browse files
committed
Add basic DEVELOPERS.md
1 parent 743895e commit 2a23b0f

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

DEVELOPERS.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Information for engine developers & contributors
2+
3+
## Testing local changes
4+
5+
To run the test suite, use `make test`.
6+
7+
Running `make image` will build `codeclimate/codeclimate-rubocop:latest`
8+
locally. It's a good idea to use a locally-built image to QA engine changes
9+
against real repos using the Code Climate CLI.
10+
11+
## Releasing a new version
12+
13+
If you are upgrading to a new version of RuboCop, please re-run the doc scraper
14+
to get any new or updated docs:
15+
16+
```
17+
docker run \
18+
--rm --volume "$PWD:/usr/src/app" --user root --workdir /usr/src/app \
19+
codeclimate/codeclimate-rubocop bundle exec rake docs:scrape
20+
sudo chown -R $(id -u):$(id -g) config
21+
```
22+
23+
You should add any new cops without docs that fail specs to
24+
`spec/support/currently_undocumented_cops.txt`.

0 commit comments

Comments
 (0)