Add note about writing tests. Fix typo. (#471)

Also use affect, not effect, as appropriate.
pull/462/head^2
Josh Rabinowitz 5 years ago committed by GitHub
parent 2164e822d2
commit aec3ac1ae2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -107,7 +107,7 @@ This will copy the git-secret development hooks from utils/hooks into .git/hooks
5. Add an entry to CHANGELOG.md, referring to the related issue # if appropriate
6. Change the .ronn file(s) in man*/man to document your changes if appropriate
6. Change the .ronn file(s) in man/man1 and man/man7 to document your changes if appropriate
7. Now, add all your files to the commit with `git add --all` and commit changes with `git commit`.
Write a good commit message which explains your work
@ -146,6 +146,15 @@ Cloud CI is done with the help of `travis`. `travis` handles multiple environmen
1. Install required gems with `bundle install`.
2. Run ci-tests with `bundle exec kitchen verify --test-base-path="$PWD/.ci/integration"`
### Writing tests
`git-secret` uses [bats-core](https://github.com/bats-core/bats-core) for testing.
See the files in tests/ and the `bats-core` documentation for details.
Because the output of many commands can be affected by the SECRETS_VERBOSE environment
variable (which enables verbosity), it's best not to expect a particular number of lines of
output from commands.
### Release process
The release process is defined in the `git`-hooks and `.travis.yml`.

@ -26,7 +26,7 @@ GPG maintains backwards compatibility but not forwards compatibility. Running a
## Approach
git-secret will move away from using the keyring format as shared storage of public keys. Instead, it will store public keys as exported keys in ASCII armor format. The public key export format is stable and forwards compatible. GPG users will typically be running different GPG or PGP versions and are able to exchange keys successfully. Bugs that effect git-secret's ability to use exported public keys will likely affect typical GPG key exchange usage. Such bugs are likely to be caught and fixed by the wider open source community.
git-secret will move away from using the keyring format as shared storage of public keys. Instead, it will store public keys as exported keys in ASCII armor format. The public key export format is stable and forwards compatible. GPG users will typically be running different GPG or PGP versions and are able to exchange keys successfully. Bugs that affect git-secret's ability to use exported public keys will likely affect typical GPG key exchange usage. Such bugs are likely to be caught and fixed by the wider open source community.
git-secret may need to store and process meta-data about keys to make it efficient to work with keys that are stored within individual files. It will use the machine-readable ["colon listings format"](https://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob_plain;f=doc/DETAILS) for this purpose.

Loading…
Cancel
Save