From f559bcb3847852397d48eae85100085754d9fcad Mon Sep 17 00:00:00 2001 From: Eric Trenkel Date: Thu, 27 Oct 2022 23:09:25 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0236bc5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +## Contribute + +You are very welcome to contribute to this project in order to make it better. + +### Missing distributions + +If you find any missing distribution that you think should be added please open a [Distro request](https://github.com/bostrot/wsl2-distro-manager/issues/new?assignees=&labels=distro+request&template=distro-request.md&title=Add+a+new+distribution). + +### Docs + +Currently generated API docs are available. You can find the documentation [here](https://bostrot.github.io/wsl2-distro-manager/api/index.html). + +### Code contributions + +If you have made a code contribution feel free to open a PR and/or an issue. + +### Language contributions + +Localizations are saved in `/lib/i18n/` as json files. New languages can be added either directly in the appropriate json file (e.g. `en.json`) or via the localizations [windows/mac application](https://github.com/Flutterando/localization/releases) which provides a GUI. + +As of some restrictions with fluent_ui package currently it is easier not to use the country code in the file name so instead of `en_US.json` just `en.json`. + +Feel free to publish a PR :)