From b069867859fbd6a82800bd972986056d22981a26 Mon Sep 17 00:00:00 2001 From: Peter Toth Date: Fri, 21 Jun 2024 01:15:18 +0400 Subject: [PATCH] Add contribution instructions to the readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index c0036ce..9b17d41 100644 --- a/README.md +++ b/README.md @@ -249,3 +249,22 @@ features, mainly inspired by [smartcd]. [antigen]: https://github.com/Tarrasch/antigen-hs [smartcd]: https://github.com/cxreg/smartcd + +## Contributing + +Bug reports, contributions and forks are welcome. All bugs or other forms of +discussion happen on https://github.com/Tarrasch/zsh-autoenv/issues. + +### Testing + +To run our tests you need to have `cram` installed. You can do this by running: + +```bash +% pip install cram +``` + +Then you can run the tests by running: +```bash +% make test_full # Run all tests +% make test tests/varstash-alias.t # Run a single test +```