Skip to content

Commit 936df21

Browse files
authored
Merge pull request #4 from conjurinc/oss_requirements_2
OSS Requirements II
2 parents b2a803f + 937402a commit 936df21

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed
53.3 KB
Binary file not shown.

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,15 @@ 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
32+
## Release Status: Alpha
3333
TL;DR: Ready for use, but needs expansion.
3434

3535
The functions in this repo are tested and ready for use, but certain libs
3636
are pretty much place holders (eg logging). Those need further contributions
3737
before they provide a comprehensive solution.
3838

39+
## License: Apache 2.0
40+
See the [license file](LICENSE)
3941

4042
## Usage
4143

@@ -178,10 +180,23 @@ TL;DR:
178180
</table>
179181

180182
# 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+
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
185200

186201
## Testing
187202
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:
207222
}
208223
```
209224

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.
226+
227+
# Maintainers
228+
* [Hugh Saunders](github.com/hughsaunders)

0 commit comments

Comments
 (0)