@@ -297,11 +297,22 @@ Copyright © 2014-2020, [Aaron Bull Schaefer](mailto:
[email protected] ).
297
297
298
298
## Contributing
299
299
300
+ ### Linting and formatting
301
+
302
+ Please use:
303
+
304
+ - the [ shellcheck] ( https://www.shellcheck.net ) tool to check for subtle bash
305
+ scripting errors in the _ transcrypt_ file, and apply the recommendations when
306
+ possible. E.g: ` shellcheck transcrypt `
307
+ - the [ shfmt] ( https://github.com/mvdan/sh ) tool to apply consistent formatting
308
+ to the _ transcrypt_ file, e.g: ` shfmt -w transcrypt `
309
+ - the [ Prettier] ( https://prettier.io ) tool to apply consistent formatting to the
310
+ _ README.md_ file, e.g: ` prettier --write README.md `
311
+
300
312
### Tests
301
313
302
314
Tests are written using [ bats-core] ( https://github.com/bats-core/bats-core )
303
- version of "Bash Automated Testing System" and stored in the * tests/*
304
- directory.
315
+ version of "Bash Automated Testing System" and stored in the _ tests/_ directory.
305
316
306
317
To run the tests:
307
318
@@ -313,12 +324,12 @@ To run the tests:
313
324
314
325
Fixes:
315
326
316
- - Fix handling of branch merges with conflicts in encrypted files, which
317
- would previously leave the user to manually merge files with a mix of
318
- encrypted and unencrypted content.
327
+ - Fix handling of branch merges with conflicts in encrypted files, which would
328
+ previously leave the user to manually merge files with a mix of encrypted and
329
+ unencrypted content.
319
330
320
331
To apply this fix in projects that already use transcrypt: uninstall and
321
- re-init transcrypt, then add ` merge=crypt ` to the patterns in * .gitattributes *
332
+ re-init transcrypt, then add ` merge=crypt ` to the patterns in _ .gitattributes _
322
333
323
334
Improvements:
324
335
0 commit comments