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
Copy file name to clipboardExpand all lines: README.md
+24-6Lines changed: 24 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,13 +29,15 @@ 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
32
+
## Release Status: Alpha
33
33
TL;DR: Ready for use, but needs expansion.
34
34
35
35
The functions in this repo are tested and ready for use, but certain libs
36
36
are pretty much place holders (eg logging). Those need further contributions
37
37
before they provide a comprehensive solution.
38
38
39
+
## License: Apache 2.0
40
+
See the [license file](LICENSE)
39
41
40
42
## Usage
41
43
@@ -178,10 +180,23 @@ TL;DR:
178
180
</table>
179
181
180
182
# 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.
183
+
Thanks for your interest in bash-lib. Before contributing, please take a
184
+
moment to read and sign our [Contributor
185
+
Agreement](CyberArk_Open_Source_Contributor_Agreement.pdf). This provides
186
+
patent protection for all Secretless Broker users and allows CyberArk to
187
+
enforce its license terms. Please email a signed copy to <a
188
+
href="oss@cyberark.com">oss@cyberark.com</a>
189
+
190
+
Contributed bash functions are most welcome! The more we share the less we
191
+
duplicate each other. In order to keep this repo tidy, every function must be
192
+
documented in the readme and tested, the lint scripts enforce these rules.
193
+
194
+
1. Add the libraries or functions that you need
195
+
1. Add BATS tests for all new top level functions
196
+
1. Add descriptions for each function to the contents table in this readme
197
+
1. Run ./run-tests to ensure all tests pass before submitting
198
+
1. Create a PR
199
+
1. Wait for review
185
200
186
201
## Testing
187
202
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).
@@ -207,4 +222,7 @@ Example:
207
222
}
208
223
```
209
224
210
-
Test fixtures should go in /tests-for-this-repo/[fixtures](tests-for-this-repo/fixtures)/lib-name.
225
+
Test fixtures should go in /tests-for-this-repo/[fixtures](tests-for-this-repo/fixtures)/lib-name.
0 commit comments