You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: README.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,14 @@ The place to store functions that are used in pipelines for multiple repos.
29
29
30
30
Please add whatever is useful to you, but keep it tidy so its still useful to everyone else :)
31
31
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
+
32
40
## Usage
33
41
34
42
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:
169
177
</tbody>
170
178
</table>
171
179
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
+
172
186
## Testing
173
187
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).
174
188
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