Skip to content

OSS Requirements II #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 20, 2019
Merged

OSS Requirements II #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added CyberArk_Open_Source_Contributor_Agreement.pdf
View file
Open in desktop
Binary file not shown.
30 changes: 24 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,15 @@ The place to store functions that are used in pipelines for multiple repos.

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

## Release Status
## Release Status: Alpha
TL;DR: Ready for use, but needs expansion.

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

## License: Apache 2.0
See the [license file](LICENSE)

## Usage

Expand Down Expand Up @@ -178,10 +180,23 @@ TL;DR:
</table>

# Contibuting

Please contribute your bash functions! The more we share the less we duplicate each other.
In order to keep this repo tidy, every function must be documented in the readme and tested,
the lint scripts enforce these rules.
Thanks for your interest in bash-lib. Before contributing, please take a
moment to read and sign our [Contributor
Agreement](CyberArk_Open_Source_Contributor_Agreement.pdf). This provides
patent protection for all Secretless Broker users and allows CyberArk to
enforce its license terms. Please email a signed copy to <a
href="oss@cyberark.com">oss@cyberark.com</a>

Contributed bash functions are most welcome! The more we share the less we
duplicate each other. In order to keep this repo tidy, every function must be
documented in the readme and tested, the lint scripts enforce these rules.

1. Add the libraries or functions that you need
1. Add BATS tests for all new top level functions
1. Add descriptions for each function to the contents table in this readme
1. Run ./run-tests to ensure all tests pass before submitting
1. Create a PR
1. Wait for review

## Testing
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).
Expand All @@ -207,4 +222,7 @@ Example:
}
```

Test fixtures should go in /tests-for-this-repo/[fixtures](tests-for-this-repo/fixtures)/lib-name.
Test fixtures should go in /tests-for-this-repo/[fixtures](tests-for-this-repo/fixtures)/lib-name.

# Maintainers
* [Hugh Saunders](github.com/hughsaunders)