Contributing themes

You have a nice custom CSS for WalrusIRC to share to the world? Then follow these guidelines.

• Your CSS file should have a comment block at the top like this:

/*
Name: Cool Theme
Description: My wonderful theme I wrote while drunk
Author: Juju
License: GPLv3
URL: http://myownwebsite.example.com
Version: 0.1
Credits: That other random dude, This guy I stole some code from
*/

The License and Credits fields are optional, only used if you wish your theme to be released under another license than GPLv3 (not recommended) and/or you have other people to credit.

• The CSS file should be put in the public/themes/ directory, in a new file with the .css extension. If your theme uses any external assets and dependencies, you can create a new directory under that directory with the name of the .css file (without the extension). It is not recommended to change the html files only for a theme, they should be self-contained.

• The theme should also work with most major browsers under their latest versions.

• You will also want to add your theme in public/themes/themes.json so it appears in the menu.

• Now you can fork this repository, add your theme in a new commit and submit a new pull request to this repository with that commit, optionally with a screenshot in the pull request comments.

• And voilà, your theme is now an officially maintained theme for WalrusIRC. By submitting your pull request, you accept your work to be released under GPLv3 or compatible, all the assets are free to use and are indeed your work (otherwise you can credit additional authors in the comment block) and the WalrusIRC developers to maintain your theme so it won't break in the future.