Pixelfed/PixelDroid-App-Android
1
0
Fork 0
mirror of https://gitlab.shinice.net/pixeldroid/PixelDroid synced 2024-12-22 04:56:53 +01:00
Code Issues Releases Wiki Activity

Add CONTRIBUTING.md and TRANSLATION.md

Browse Source
This commit is contained in:
Matthieu 2020-12-16 21:30:49 +01:00
parent 7066c942e8
commit 1d4af5bffe
2 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,19 @@
If you want to contribute to PixelDroid, you can do so in several ways:
# Translation
You can help to translate PixelDroid to your favourite language. Please do not submit Merge Requests directly, but use our weblate at https://weblate.pixeldroid.org/projects/pixeldroid/pixeldroid/ .
You can add a new language by using the "Start new translation" button on the bottom left of the page.
Before translating, please take a look at the [TRANSLATION.md](TRANSLATION.md) file for details and some guidance.
# Creating issues on the issue tracker
If you encounter a problem or have an idea about how to make PixelDroid better, you should make an issue about it on our [GitLab project](https://gitlab.shinice.net/pixeldroid/PixelDroid/-/issues). If you encountered a problem, please make sure to document how to reproduce it, and include screenshots if possible. If you are making a suggestion, please try to be detailed in your description.
# Contribute changes or fix bugs
You can also help us solve one of the existing issues, or improve the application in some other way, by contributing changes yourself. To do this you can fork the project and submit a Merge Request.
Before starting to work on an issue or an improvement, you can ask us on our Matrix channel (#pixeldroid:gnugen.ch) what we think, or make a comment on the relevant issue, so that we might point you in the right direction, and to make sure someone else is not already working on it.

15
TRANSLATION.md Normal file
View File

@ -0,0 +1,15 @@
# Register on our Weblate instance
Sign up on our instance and go to the PixelDroid project here: https://weblate.pixeldroid.org/projects/pixeldroid/pixeldroid/
No need to specify your real name, obviously, unless you want to.
# Start translating
Go to the project's page ( https://weblate.pixeldroid.org/projects/pixeldroid/pixeldroid ). Click on the language you want to work with (for example, Catalan would be at https://weblate.pixeldroid.org/projects/pixeldroid/pixeldroid/ca/ ). Then click the "Translate" button on the right. You can then edit the missing translations and review existing ones.
For more details, you can check out Weblate's documentation: https://docs.weblate.org/en/latest/user/translating.html
## Glossaries
When translating something containing a term specific to Pixelfed, PixelDroid, or the fediverse in general, be sure to add the items to the glossary of the language you are translating to, this helps to keep translating consistent. When translating, make sure to check the glossary to use the proper terms, and if you change an entry in the glossary make sure to also edit the entries containing that term.