Skip to content

Commit dea64c4

Browse files
committed
Reorganize sections in README
The setup section used to look as if it was necessary for the users of the rule. Placed the section into the "contributing" section.
1 parent 287cdef commit dea64c4

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,12 @@
88
- [`ruby_test`](#rubytest)
99
- [`bundle_install`](#bundleinstall)
1010
- [What's coming next](#whats-coming-next)
11+
- [Contributing](#contributing)
12+
- [Setup](#setup)
1113
- [Copyright](#copyright)
12-
- [Warranty](#warranty)
1314

1415
<!-- /TOC -->
1516

16-
# Setup
17-
18-
To get the initial stuff setup required by this repo, please run the script:
19-
20-
```bash
21-
bin/setup
22-
```
23-
24-
Whenever you'll commit something, a pre-commit hook will run as well.
25-
2617
# Rules Ruby
2718

2819
[![Build Status](https://travis-ci.org/bazelruby/rules_ruby.svg?branch=master)](https://travis-ci.org/bazelruby/rules_ruby)
@@ -412,6 +403,26 @@ bundle_install(name, gemfile, gemfile_lock)
412403
2. Using a specified version of Ruby.
413404
3. Building and releasing your gems with Bazel
414405

406+
## Contributing
407+
408+
1. Setup dev tools as described in the [setup](#setup) section.
409+
2. hack, hack, hack...
410+
3. Make sure all tests pass
411+
* `bazel test //...`
412+
* `cd examples/simple_script && bazel test //...`
413+
4. Open a pull request in Github
414+
415+
### Setup
416+
417+
To get the initial stuff setup required by this repo, please run the script:
418+
419+
```bash
420+
bin/setup
421+
```
422+
423+
Whenever you'll commit something, a pre-commit hook will run as well.
424+
425+
415426
## Copyright
416427

417428
© 2018-2019 Yuki Yugui Sonoda & BazelRuby Authors

0 commit comments

Comments
 (0)