Skip to content

Commit

Permalink
chore(github): Add issue templates (#92)
Browse files Browse the repository at this point in the history
  • Loading branch information
gonzalo-bulnes authored Jan 6, 2024
1 parent 3093192 commit 4f3b7d5
Show file tree
Hide file tree
Showing 5 changed files with 104 additions and 3 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/new_language_or_locale.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "New language or locale"
about: "Please create voice packs for my language or locale!"
title: "Add language/locale: [YOUR LANGUAGE OR LOCALE]"
---

## Description

I'd like to be able to download voice packs in the following language(s) and locale(s):

<!-- Please list the languages or locales that you'd like to use. Example: `fr_BE`, Japanese, Spanish (Colombia) and add them to the issue title as well. You can find the (BCP-47) code for many locales in https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts#supported-languages. But using words is fine as well. -->

- `en_US` <!-- for example -->

## Help make EdgeTX better!

<!-- You'll be able to check these boxes once the issue is created. -->

- [ ] (optional) I can help reviewing the translations.
- [ ] (optional) I can help reviewing the sounds once they're generated.
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: "New voice for existing language or locale"
about: "Please create additional voice packs for my language or locale!"
title: "Add voice to language/locale: [YOUR LANGUAGE OR LOCALE]"
---

## Description

I'd like to be able to download voice packs with the following voice(s) from Azure AI Speech Studio ([list of available voices][voices] and [voice gallery][gallery]):

<!-- Please list voices from the Azure Speech Services that you'd like to use. Example: `fr_BE`, Japanese, Spanish (Colombia) and add them to the issue title as well. -->

- `cs-CZ-VlastaNeural` <!-- for example -->

## Help make EdgeTX better!

<!-- You'll be able to check these boxes once the issue is created. -->

- [ ] (optional) I can help reviewing the new voice packs once they're generated.

[gallery]: https://speech.microsoft.com/portal/voicegallery
[voices]: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts#prebuilt-neural-voices
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/wrong_pronunciation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: "Wrong pronunciation"
about: "A phrase is correctly translated but sounds wrong in my language or locale."
title: "Wrong pronunciation in [YOUR LANGUAGE OR LOCALE]"
---

## Description

<!-- Please specify the language or locale that you're using, and the terms that are incorrectly pronounced. Don't forget to add the language or locale in the title of the issue as well. -->

The following sounds are incorrectly pronounced:

- Language or locale: `fr_FR` <!-- for example -->
- Incorrectly sounds like: "mode pi"
- Should sound like: "mode pite"

## Help make EdgeTX better!

<!-- You'll be able to check these boxes once the issue is created. -->

- [ ] (optional) I can help reviewing the new sounds once they're generated.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/wrong_translation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: "Wrong translation"
about: "A phrase is incorrectly translated in my language or locale."
title: "Wrong translation in [YOUR LANGUAGE OR LOCALE]"
---

## Description

<!-- Please specify the language or locale that you're using, and the terms that are incorrectly translated. Don't forget to add the language or locale in the title of the issue as well. -->

The following sounds are incorrect:

- Language: `fr_FR` <!-- for example -->
- Incorrect: "mode fosse"
- Correct: "mode pit"

## Help make EdgeTX better!

<!-- You'll be able to check these boxes once the issue is created. -->

- [ ] (optional) I can help reviewing the new sounds once they're generated.
23 changes: 20 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,24 @@ There are several ways to contribute to the evolution of the EdgeTX audio packag

We are now starting the new audio package, using neural network technology to generate more realistic voices, removing the familiar robotic sound from voices. Our goal is to have clearer, cleaner audio and to be reproduced with quality on all transmitters. With this, your opinion is very important to know if you are enjoying the result and if you have encountered any problems.

If you have encountered any issues or want to contribute your opinion, please [open a new Issue](https://github.com/EdgeTX/edgetx-sdcard-sounds/issues).
If you have encountered any issues or want to contribute your opinion, please [open a new issue][new-issue].

## Fixing translation errors
## Contributing new languages
## Reporting translation errors

We are offering audio packages for different languages, and relying on automated translations for some of them. If you hear something that seems incorrect in your language, please [open a new issue][new-issue].

## Reporting pronunciation errors

The technologies that are used to generate voices don't always read the text the way an EdgeTX user would. That is especially true for words that are very specific to remote-controlled crafts. If you notice imperfections in how a given text is read, please [open a new issue][new-issue]. That may allow us to adjust the text and get a better output.

## Expressing interest for new languages or locales

The languages (e.g. English) and locales (e.g. `GB`, `US`) that are currently available have been requested over time. If you'd like to use an audio package in a different language or a specific locale, please let us know by [opening a new issue][new-issue].

## Fixing errors and contributing code

If you want to fix existing errors or contribute ideas or code, you are welcome to say so in any open issue, or to open a pull request!

If you need guidance to navigate this repository or opening a pull request, please say so, we'll be happy to help you get started.

[new-issue]: https://github.com/EdgeTX/edgetx-sdcard-sounds/issues/choose

0 comments on commit 4f3b7d5

Please sign in to comment.