From 6d04986e754a77da4ff8cb221180e76baeb49627 Mon Sep 17 00:00:00 2001 From: Henry Bley-Vroman Date: Sat, 7 Mar 2020 18:39:49 -0500 Subject: [PATCH] feat(CONTRIBUTING): new file for GitHub friendliness --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ ROADMAP.md | 2 +- 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..0cb0bce8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing + +Thanks for your interest. Contributions are welcome! + +> Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. + +Check the [Issues](https://github.com/olets/zsh-abbr/issues) to see if your topic has been discussed before or if it is being worked on. You may also want to check the roadmap (see above). Discussing in an Issue before opening a Pull Request means future contributors only have to search in one place. + +This project loosely follows the [Angular commit message conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit). This helps with searchability and with the changelog, which is generated automatically and touched up by hand only if necessary. Use the commit message format `(): `, where `` is **feat** for new or changed behavior, **fix** for fixes, **docs** for documentation, **style** for under the hood changes related to for example zshisms, **refactor** for other refactors, **test** for tests, or **chore** chore for general maintenance (this will be used primarily by maintainers not contributors, for example for version bumps). `` is more loosely defined. Look at the [commit history](https://github.com/olets/zsh-abbr/commits/master) for ideas. + +Tests are in the `tests` directory. To run them, replace `zsh-abbr` with `zsh-abbr/tests` in .zshrc. For example, zinit users will run + +```shell +zinit ice lucid +zinit light olets/zsh-abbr/tests +``` + +in place of + +```shell +zinit ice lucid +zinit light olets/zsh-abbr +``` + +Open a new session and the tests will run. diff --git a/ROADMAP.md b/ROADMAP.md index 914d5fb2..5025ea92 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -18,7 +18,7 @@ Key: Github -- [ ] move contribution documentation to a CONTRIBUTING.md +- [x] move contribution documentation to a CONTRIBUTING.md Chrome