Skip to content

Commit 2bb375c

Browse files
committed
Add OSS requirements to readme
Most of the internal requirements required for open sourcing a repo were already met, however the readme needed some additions: * Contributing Section * Release Status Section
1 parent 85c2c63 commit 2bb375c

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,14 @@ The place to store functions that are used in pipelines for multiple repos.
2929

3030
Please add whatever is useful to you, but keep it tidy so its still useful to everyone else :)
3131

32+
## Release Status
33+
TL;DR: Ready for use, but needs expansion.
34+
35+
The functions in this repo are tested and ready for use, but certain libs
36+
are pretty much place holders (eg logging). Those need further contributions
37+
before they provide a comprehensive solution.
38+
39+
3240
## Usage
3341

3442
Add bash-lib into your project in the way that best fits your workflow. The only requirement is that you **pin the version of
@@ -169,6 +177,12 @@ TL;DR:
169177
</tbody>
170178
</table>
171179

180+
# Contibuting
181+
182+
Please contribute your bash functions! The more we share the less we duplicate each other.
183+
In order to keep this repo tidy, every function must be documented in the readme and tested,
184+
the lint scripts enforce these rules.
185+
172186
## Testing
173187
Tests are written using [BATS](https://github.com/bats-core/bats). Each libould have a `lib-name.bats` file in [tests-for-this-repo](/tests-for-this-repo).
174188
Asserts are provided by [bats-assert-1](https://github.com/jasonkarns/bats-assert-1). The value in these is that they provide useful debugging output when the assertion fails, eg expected x got y.

0 commit comments

Comments
 (0)