2.5 KiB
Contributing
You're welcome to contribute to the code or to the translations!
Table of contents
Contributing to the code
You'll need make and NPM to install the development dependencies:
npm install --save-dev
Create a new branch describing what your're working on, for example feature/{name-of-the-feature} or theme/{name-of-the-theme}.
When you're done, commit all your changes and create a new merge request. Choose the appropriate merge request template.
Coding style
We follow the GNOME Shell coding style and we use ESLint to enforce it.
To make sure your code follows it:
npm run test-lint
Copyright notice
If you make changes to a file, please your copyright notice to the top of the file, or in a separate file (named original-file.ext.license), following the SPDX specification.
Run reuse to check that all the needed information is present:
reuse lint
Themes and unit tests
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.
To run the tests:
npm run test-variants
Localized strings
If you modify localized strings, make your changes available for translation:
make pot
Contributing to the translations
The project uses Weblate to manage translations. Head over Night Theme Switcher's project page to start translating the extension. If you need help, check out Weblate's user documentation.
Current translation status:
