From dac94dc77dfea40c52ce22d88373e047a3d0395c Mon Sep 17 00:00:00 2001 From: Avery Date: Tue, 5 Dec 2023 17:44:15 -0500 Subject: [PATCH] Add contribution guidelines --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2deb512 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contribution Guidelines + +- If you think you've found a security vulnerability, please email + delfin@avery.cafe + +## Bug Reports and Feature Requests + +You can report bugs or file feature requests on the +[issue tracker](https://codeberg.org/avery42/delfin). + +- Before creating an issue, do a quick search to check if the issue has already + been reported. +- When creating an issue, + please choose the appropriate template, and follow it to the best of your + ability. + - Following the templates helps to ensure that you include the relevant + information in your issue, and reduces back and forth. + +## Development + +See [Development Setup](https://codeberg.org/avery42/delfin#development-setup). + +Before working on a change or new feature, please open an issue for discussion. +At this stage, Delfin aims to provide a cohesive UI for the most important +features. Before implementation, there should be a discussion about how a new +feature will fit into the app, along with whether the feature even belongs in +the first place. + +## Translations + +Contributions to translations are welcome on +[Weblate](https://translate.codeberg.org/projects/delfin/). + +Delfin's translations are using the +[Fluent localization system](https://projectfluent.org/). A syntax guide is +availble [here](https://projectfluent.org/fluent/guide/). + + + Translation status + + +
+ + Translation status +