Update README with Contributing

2020-02-14 01:54:59 +01:00
parent bae2f18e40
commit 386fda134e
1 changed files with 19 additions and 0 deletions
@@ -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
+```