brammp/Curl-ttfb
1
0
Fork 0
mirror of https://github.com/jaygooby/ttfb.sh synced 2025-12-09 23:47:21 +01:00
Code Issues Releases Wiki Activity

Create CONTRIBUTING.md

Browse Source
This commit is contained in:
Jay Caines-Gooby
2022-07-05 10:30:58 +01:00
committed by GitHub
parent 6cc2af0211
commit fd11ab5aa0
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,11 @@
# Thanks for helping with ttfb!
Tests live in the [`tests/tests.bats` file](tests/tests.bats) if you're adding a bugfix or making a small change, please ensure all tests pass.
To run the tests, call `make` from the project root. You'll need to have [bats-core](https://github.com/bats-core/bats-core) installed and in your `$PATH`.
If you only want to run a test or two, uncomment the `# skip` lines on the tests you don't care about, so they read `skip`, and then those tests will be skipped.
If you're thinking about new functionality, check that it can't be achieved by passing `-o` options to curl; for instance, there's no need to raise a PR that makes `ttfb` ignore invalid certificates, you can achieve this by calling ttfb like `ttfb -o "-k" https://example.com` - the `-k` option is added to the `curl` call, and will therefore ignore invalid or expired certificates.
If you do want to add new functionality, please also add a test to [`tests/tests.bats` file](tests/tests.bats).