Skip to content

Commit

Permalink
chore: Update README template
Browse files Browse the repository at this point in the history
  • Loading branch information
DeclanChidlow authored Oct 25, 2024
1 parent b5b49e2 commit ced2eb2
Showing 1 changed file with 31 additions and 26 deletions.
57 changes: 31 additions & 26 deletions README.template.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,45 @@
# Revolt Translations

[![Translation status](https://weblate.insrt.uk/widgets/revolt/-/web-app/svg-badge.svg)](https://weblate.insrt.uk/engage/revolt/?utm_source=widget)

This repository contains Revolt's translation files. Feel free to help translate Revolt to new languages or fix/improve existing translations on [our Weblate instance](https://weblate.insrt.uk/projects/revolt/web-app/).

**Please do not submit fixes or new translations via pull requests.** Only open a pull request if you are adding new strings to the source language (en_GB) or if you're modifiying the scripts contained in this repository.
<div align="center">
<h1>
Revolt Translations

[![Stars](https://img.shields.io/github/stars/revoltchat/translations?style=flat-square)](https://github.com/revoltchat/translations/stargazers)
[![Forks](https://img.shields.io/github/forks/revoltchat/translations?style=flat-square)](https://github.com/revoltchat/translations/network/members)
[![Pull Requests](https://img.shields.io/github/issues-pr/revoltchat/translations?style=flat-square)](https://github.com/revoltchat/translations/pulls)
[![Issues](https://img.shields.io/github/issues/revoltchat/translations?style=flat-square)](https://github.com/revoltchat/translations/issues)
[![Contributors](https://img.shields.io/github/contributors/revoltchat/translations?style=flat-square)](https://github.com/DeclanChidlowRepo/Template/graphs/contributors)
[![Licence](https://img.shields.io/github/license/revoltchat/translations?style=flat-square)](https://github.com/revoltchat/translations/blob/main/LICENCE)
<br>
[![Revolt Server](https://img.shields.io/revolt/invite/01H14M0JCRWT52VW7BR1XH5Y5W?style=flat-square&label=revolt%20server)](https://rvlt.gg/translation)
[![Weblate Projects](https://img.shields.io/weblate/projects?server=https%3A%2F%2Ftranslate.revolt.chat&style=flat-square
)](https://translate.revolt.chat/projects)
[![Weblate Users](https://img.shields.io/weblate/users?server=https%3A%2F%2Ftranslate.revolt.chat&style=flat-square
)](https://translate.revolt.chat/user)
[![Weblate Languages](https://img.shields.io/weblate/languages?server=https%3A%2F%2Ftranslate.revolt.chat&style=flat-square
)](https://translate.revolt.chat/languages)
</h1>
The repo managing translations at Revolt.
</div>
<br/>

This repository contains translation files and acts as a way to handle and manage requests. You can help translate Revolt to new languages and improve existing translations on [Revolt's Weblate](https://translate.revolt.chat).

> [!IMPORTANT]
> **Don't** submit fixes or new translations via pull requests. Please only open a pull request if adding new strings to the source language (en_GB) or modifying the scripts contained within this repository.
## Languages

The following table shows a list of languages, their contributors and maintainers (people enlisted to verify that the language's translations are up to standard).
The following table shows a list of languages, their contributors, and maintainers (people enlisted to verify that the language's translations are up to standard).

Please note that this table **only includes languages that are currently available in the app**. If a language has been translated via Weblate and you want it to be added to the app, [please click here](https://github.com/revoltchat/frontend/issues/135).

{{TABLE}}

If you would like to maintain a language, please [open an issue](https://github.com/revoltchat/translations/issues/new/choose) with your request.

### What do I do?
## What is a Maintainer?

#### As a language maintainer

As a maintainer, you gain access to the Reviewer role on Weblate. This lets you approve new strings, edit approved strings and accept new suggestions. You may also be mentioned in GitHub issues to approve badges for others.
Maintainers gain access to the Reviewer role on Weblate. This permits them to approve new strings, edit approved strings, and accept new suggestions. They may also be mentioned in GitHub issues to approve badges for others.

![Approval UI](assets/approve_ui.png)

If you would like to be removed as a maintainer, please create an issue. (You will remain on the contributions list.)

#### As a repository maintainer

There are two different things that need to be handled:

- Languages proposed in [this issue](https://github.com/revoltchat/revite/issues/362) should be added to [Languages.ts](https://github.com/revoltchat/translations/blob/master/Languages.ts).
- Handle issues on this repository:
- Badge requests: ensure that the language has a maintainer, ping any relevant maintainers to verify translations if you cannot yourself, afterwards the user can be added to the [list here](https://github.com/revoltchat/translations/blob/master/contributors.json)
- Maintainership requests: ensure the user has sufficient contributions, then add them to the [list here](https://github.com/revoltchat/translations/blob/master/contributors.json)

## Coverage

[![Translation status](https://weblate.insrt.uk/widgets/revolt/-/web-app/multi-auto.svg)](https://weblate.insrt.uk/engage/revolt/?utm_source=widget)
If you're a maintainer and no longer wish to be one, please [open an issue](https://github.com/revoltchat/translations/issues/new). Note that you will remain on the contributions list.

0 comments on commit ced2eb2

Please sign in to comment.