Skip to content

Commit 9925809

Browse files
committed
Update documentation in prep for v1.0.0
1 parent c72222e commit 9925809

File tree

3 files changed

+186
-103
lines changed

3 files changed

+186
-103
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ painful to follow the discussion.
5757
If you _do_ have something to add to the conversation, or _don't_ find a
5858
matching issue...
5959

60-
### File a new issue or update an existing one
60+
### Update an existing issue or file a new one
6161

6262
Try to be as specific as possible about your environment and the problem you're
6363
observing. At a minimum, include:
@@ -76,6 +76,14 @@ Also consider using:
7676

7777
## Updating documentation
7878

79+
If you've a passion for writing clear, accessible documentation, please don't be
80+
shy about sending pull requests! The documentation is just as important as the
81+
code, especially in this project, since the goal is to make the functionality as
82+
discoverable as possible through the `./go help` command.
83+
84+
Also: _no typo is too small to fix!_ Really. Of course, batches of fixes are
85+
preferred, but even one nit is one nit too many.
86+
7987
## Environment setup
8088

8189
Make sure you have Bash installed per the [Environment setup in the
@@ -110,7 +118,29 @@ original.
110118

111119
## Testing
112120

121+
- Continuous integration status: [![Continuous integration status](https://travis-ci.org/mbland/go-script-bash.png?branch=master)](https://travis-ci.org/mbland/go-script-bash)
122+
- Coverage status: [![Coverage Status](https://coveralls.io/repos/github/mbland/go-script-bash/badge.svg?branch=master)](https://coveralls.io/github/mbland/go-script-bash?branch=master)
123+
113124
No bug fixes or new features will be accepted without accompanying tests.
125+
Period.
126+
127+
Any changes that break the continuous integration build must be fixed or rolled
128+
back immediately.
129+
130+
This project uses the [Bash Automated Testing System
131+
(Bats)](https://github.com/sstephenson/bats) to write and run tests. All tests
132+
and helper scripts are in the `tests/` directory and are run using the `./go
133+
test` command. This command has a very flexible syntax for running a subset of
134+
test suites (i.e. a set of test cases within individual `.bats` files or
135+
directories). Enabling tab completion via `./go env` is highly encouraged.
136+
137+
Before sending your code for review, make sure to run the entire test suite via
138+
`./go test`. If you're on a Linux system that uses the `apt-get` package manager
139+
(e.g. Ubuntu, Debian), run `./go test --coverage` to make sure your changes are
140+
adequately covered by new and existing tests. This will install (within the
141+
project working directory) and run the
142+
[kcov](https://github.com/SimonKagstrom/kcov) tool, which is only available on
143+
Linux for now.
114144

115145
## Coding conventions
116146

0 commit comments

Comments
 (0)