diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3ac6e24 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing + +Pull requests are welcome. Most changes in code, especially new features, should be accompanied by new tests. + +We recommend using [Nix](https://nixos.org) when working on Drasl. This repository includes a `flake.nix` supplying a development environment (run `nix develop` or use [direnv](https://direnv.net)) and a build script (run `nix build`). + +We use [pre-commit](https://pre-commit.com) for pre-commit hooks. Before you `git commit`, set up [pre-commit](https://pre-commit.com) (it's already included in the Nix development environment) and run `pre-commit install`. + +## Translations + +Translating Drasl from English to other languages happens on [Hosted Weblate](https://hosted.weblate.org/projects/unmojang/drasl). All contributions are welcome, including translations to new languages and suggestions to improve existing translations. + +translation status