Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
timokoessler committed Oct 3, 2024
1 parent 40897d6 commit 2a85fbe
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
# Contributing

Any contribution is greatly appreciated 🥳.

To get an overview of the project, read the README and take a look at the source files.
Any contribution is greatly appreciated 🥳. You don't need to be a developer to contribute. You can help by translating the app, reporting issues, or simply sharing your ideas for new features.

If you have any questions, please do not hesitate to contact me. You can find my contact information in the README and on my website.

Read our [Code of Conduct](CODE_OF_CONDUCT.md) to keep our community approachable and respectable.

## Security

If you would like to report a security vulnerability, please take a look at [SECURITY.md](SECURITY.md)

## Code of Conduct
## Translations

Read our [Code of Conduct](CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
[![Crowdin](https://badges.crowdin.net/2faguard/localized.svg)](https://translate.2faguard.app)

## Translations
### Adding a new language

If you want to add a new language, you have multiple options:

1. Create a pull request on GitHub that adds the new translations in the `Guard.WPF/Resources` folder. Don't worry if you don't know how to integrate the translations into the application code.
2. Contact me and ask me to add a new language to the [Crowdin project](https://translate.2faguard.app). This allows you to use a comfortable web interface to translate the app.
3. Send me the translation file via email to [[email protected]](mailto:[email protected]).

### Improve existing translations

If you would like to help translate the app, you can find the translation files in the `Guard.WPF/Resources' folder. Once you have made your changes, create a pull request. Don't worry if you don't know how to integrate the translations into the application code. If you are not familiar with Git, you can also email me the files.
If you want to improve existing translations, please register for a free account on [Crowdin](https://translate.2faguard.app) and start suggesting new translations or improving existing ones.

## Code contributions

I am happy to accept code contributions. Please make sure that your changes are understandable and well tested.
I am happy to accept code contributions. Please make sure that your changes are understandable.
If you want to add breaking changes or completely new features, please open an issue first to discuss it.
If you are unsure about something, feel free to reach out to me.

0 comments on commit 2a85fbe

Please sign in to comment.