From 386fda134e66df9044b9304c46154b5f9aa47225 Mon Sep 17 00:00:00 2001 From: Romain Vigier Date: Fri, 14 Feb 2020 01:54:59 +0100 Subject: [PATCH] Update README with Contributing --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index c6f75ff..ed58a71 100644 --- a/README.md +++ b/README.md @@ -51,3 +51,22 @@ Restart your GNOME session and enable the extension: ```bash gnome-extensions enable nightthemeswitcher@romainvigier.fr ``` +## Contributing + +You're welcome to contribute to the code! + +Please follow the coding style of each file. If you make changes to a file, please add your copyright notice at the top of the file, in the form `Copyright (C) YEAR Your Name`. + +If you add support for a theme, please write a unit test for each of its variants, in the `tests` directory, with the theme name as filename. Unit tests are written for [AVA](https://github.com/avajs/ava) and run with node and npm. + +To install the tests dependencies: + +```bash +npm install +``` + +To run the tests: + +```bash +make test +```