github/wait-for
0
0
Fork 0
mirror of https://github.com/thegeeklab/wait-for.git synced 2024-11-28 07:10:35 +00:00
Code Issues Projects Releases Wiki Activity

docs: add contributing information

Browse Source
This commit is contained in:
Robert Kaussow 2021-01-04 16:20:19 +01:00
parent 192ec10ea6
commit fd33f0082f
No known key found for this signature in database
GPG Key ID: 65362AE74AF98B61
2 changed files with 37 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,31 @@
# Contributing
## Security
If you think you have found a **security issue**, please do not mention it in this repository.
Instead, send an email to security@thegeeklab.de with as many details as possible so it can be handled confidential.
## Bug Reports and Feature Requests
If you have found a **bug** or have a **feature request** please use the search first in case a similar issue already exists.
If not, please create an issue in this repository
## Code
If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request.
Before you start any Pull Request, it is recommended that you create an issue to discuss first if you have any
doubts about requirement or implementation. That way you can be sure that the maintainer(s) agree on what to change and how,
and you can hopefully get a quick merge afterwards.
Pull Requests can only be merged once all status checks are green.
## Do not force push to your Pull Request branch
Please do not force push to your Pull Requests branch after you have created your Pull Request, as doing so makes it harder for us to review your work.
Pull Requests will always be squashed by us when we merge your work. Commit as many times as you need in your Pull Request branch.
## Re-requesting a review
Please do not ping your reviewer(s) by mentioning them in a new comment. Instead, use the re-request review functionality.
Read more about this in the [GitHub docs, Re-requesting a review](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#re-requesting-a-review).

11
README.md
View File

@ -9,7 +9,7 @@ Poor-mans docker service synchronizer
[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/wait-for)
[![License: MIT](https://img.shields.io/github/license/thegeeklab/wait-for)](https://github.com/thegeeklab/wait-for/blob/master/LICENSE)
wait-for is a script designed to synchronize services like docker containers. It is [sh](https://en.wikipedia.org/wiki/Bourne_shell) and [alpine](https://alpinelinux.org/) compatible. It was inspired by [vishnubob/wait-for-it](https://github.com/vishnubob/wait-for-it), but the core has been rewritten at [Eficode](http://eficode.com/) by [dsuni](https://github.com/dsuni) and [mrako](https://github.com/mrako).
wait-for is a script designed to synchronize services like docker containers. It is [sh](https://en.wikipedia.org/wiki/Bourne_shell) and [alpine](https://alpinelinux.org/) compatible and was forked from [eficode/wait-for](https://github.com/eficode/wait-for).
When using this tool, you only need to pick the `wait-for` file as part of your project.
@ -33,12 +33,12 @@ optional arguments:
## Examples
To check if [eficode.com](https://eficode.com) is available:
To check if [google.com](https://google.com) is available:
```Shell
$ ./wait-for www.eficode.com:80 -- echo "Eficode site is up"
$ ./wait-for google.com:80 -- echo "Google site is up"
Eficode site is up
Google site is up
```
To wait for database container to become available:
@ -59,7 +59,8 @@ services:
## Contributors
Special thanks goes to all [contributors](https://github.com/thegeeklab/wait-for/graphs/contributors).
Special thanks goes to all [contributors](https://github.com/thegeeklab/wait-for/graphs/contributors). If you would like to contribute,
please see the [instructions](https://github.com/thegeeklab/wait-for/blob/master/CONTRIBUTING.md).
## License