diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ab3ea9f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +## 🌍 Help Translate + +We want **BetterLyrics** to be accessible to everyone, and your help in translating it is greatly appreciated! We use **Crowdin** to manage localization. + +### How to Contribute + +1. **Join the Project:** + Accept our invitation to join the translation team via Crowdin: + [Join BetterLyrics on Crowdin](https://crowdin.com/project/betterlyrics/invite?h=413bb0df7afa420247a98fefdae5e12c2647410) + +2. **Translate & Proofread:** + Once you have joined, you are welcome to translate new strings or proofread existing language resources. + > **Note:** Please only **approve** a translation if you are native or fluent in that language and are confident in its accuracy. + +### Syncing and Recognition + +* **Synchronization:** Crowdin automatically syncs translations to GitHub periodically. +* **Merging:** Once you have completed proofreading a language and the resources have synced to GitHub via a Pull Request, the maintainers will merge the changes. +* **Credit:** After the merge, your Crowdin profile will be automatically added to the **Contributors** column in the Translation section of the `README` file. + +Thank you for helping us make BetterLyrics better!