From 2650a2b9035499baf99a281c0937f76dc201c6e4 Mon Sep 17 00:00:00 2001 From: Uiolee <22849383+uiolee@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:29:33 +0800 Subject: [PATCH] update contributing guide of translations (#2262) --- .github/PULL_REQUEST_TEMPLATE.md | 24 +++++++++--------------- README.md | 14 +++++++++++--- source/docs/contributing.md | 16 ++++++++++++---- 3 files changed, 32 insertions(+), 22 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b46115b9cf..9d3c859980 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,29 +19,23 @@ - [ ] Others (Update, fix, translation, etc...) - Languages: - [ ] `en` English - - [ ] `ru` Russian - - [ ] `zh-cn` simplified Chinese - - [ ] `zh-tw` traditional Chinese - - [ ] `ja` Japanese - + - diff --git a/README.md b/README.md index ebb418ac1e..674e792471 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The website for Hexo. Install dependencies: -``` bash +```bash git clone https://github.com/hexojs/site.git cd site npm install @@ -18,16 +18,24 @@ npm install Generate: -``` bash +```bash hexo generate ``` Run server: -``` bash +```bash hexo server ``` +## Contributing + +Before you open pull requests, please refer to the guide: + +- [Add your plugin to `hexo.io/plugins/`](https://hexo.io/docs/plugins#Publishing) +- [Add your theme to `hexo.io/themes/`](https://hexo.io/docs/themes#Publishing) +- [Update Documentation](https://hexo.io/docs/contributing#Updating-Documentation) + ## Contributors - English - [tommy351](https://github.com/tommy351) diff --git a/source/docs/contributing.md b/source/docs/contributing.md index 2ad1f1bc7b..5217ede2e5 100644 --- a/source/docs/contributing.md +++ b/source/docs/contributing.md @@ -87,10 +87,18 @@ $ hexo server ### Translating -1. Add a new language folder in `source` folder. (All lower case) -2. Copy Markdown and template files in `source` folder to the new language folder. -3. Add the new language to `source/_data/language.yml`. -4. Copy `en.yml` in `themes/navy/languages` and rename it to the language name (all lower case). +#### Contribute translations + +[![Crowdin](https://badges.crowdin.net/hexo/localized.svg)](https://crowdin.com/project/hexo) + +Now we use the [Crowdin](https://crowdin.com/project/hexo) platform for translation, where anyone can contribute translations and vote for translations without manual git operations. + +#### Add a new language + +1. Summit a new issue to let us know. The members with access to the [Crowdin Project](https://crowdin.com/project/hexo) add the language in settings. +1. After adding language in Crowdin, anyone can contribute translations on it. +1. Add the new language to [`source/_data/language.yml`](https://github.com/hexojs/site/blob/master/source/_data/languages.yml). +1. Copy `en.yml` in [`themes/navy/languages`](https://github.com/hexojs/site/tree/master/themes/navy/languages) and rename it to the language name (all lower case). ## Reporting Issues