From 49488ef11850d066efdf35600c7cabbff027f94b Mon Sep 17 00:00:00 2001 From: squidfunk Date: Tue, 29 Jun 2021 11:06:39 +0200 Subject: [PATCH] Polished issue template --- .github/ISSUE_TEMPLATE/translate.yml | 122 +++++++++++++-------------- 1 file changed, 60 insertions(+), 62 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/translate.yml b/.github/ISSUE_TEMPLATE/translate.yml index 93ce7c133..e4ccf89de 100644 --- a/.github/ISSUE_TEMPLATE/translate.yml +++ b/.github/ISSUE_TEMPLATE/translate.yml @@ -1,64 +1,62 @@ name: Translate -description: 'Help translate Material into more languages' -title: 'New translation: {Insert language}' -labels: [enhancement] +description: Add localization for a new language +title: 'New language: {replace with language name}' body: -- type: markdown - attributes: - value: |- - ## Instructions - - 1. Check, if your language is already available: [here](https://bit.ly/33vFDD0) - 2. If it isn't, please translate the labels on the right: - - ```jinja - {% macro t(key) %}{{ { - "language": "en", - "direction": "ltr", - "clipboard.copy": "Copy to clipboard", - "clipboard.copied": "Copied to clipboard", - "edit.link.title": "Edit this page", - "footer.previous": "Previous", - "footer.next": "Next", - "footer.title": "Footer", - "header.title": "Header", - "meta.comments": "Comments", - "meta.source": "Source", - "nav.title": "Navigation", - "search.config.lang": "en", - "search.config.pipeline": "trimmer, stopWordFilter", - "search.config.separator": "[\s\-]+", - "search.placeholder": "Search", - "search.reset": "Clear", - "search.result.initializer": "Initializing search", - "search.result.placeholder": "Type to start searching", - "search.result.none": "No matching documents", - "search.result.one": "1 matching document", - "search.result.other": "# matching documents", - "search.result.more.one": "1 more on this page", - "search.result.more.other": "# more on this page", - "search.result.term.missing": "Missing", - "select.language.title": "Select language", - "select.version.title": "Select version", - "skip.link.title": "Skip to content", - "source.link.title": "Go to repository", - "source.file.date.updated": "Last update", - "source.file.date.created": "Created", - "tabs.title": "Tabs", - "toc.title": "Table of contents", - "top.title": "Back to top" - }[key] }}{% endmacro %} - ``` -- type: textarea - attributes: - label: Translation - description: Put your translated file here. The text is automatically formatted as Jinja code - placeholder: |- - {% macro t(key) %}{{ { - "language": "en", - "direction": "ltr", - ... - }[key] }}{% endmacro %} - render: jinja - validations: - required: true + - type: checkboxes + attributes: + label: Contribution guidelines + description: Please read the contribution guidelines before proceeding. + options: + - label: I've read the [contribution guidelines](https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md) and wholeheartedly agree + required: true + - type: checkboxes + attributes: + label: Language availability + description: Please ensure that the language you're adding isn't already available + options: + - label: I've checked the [list of available languages](https://bit.ly/33vFDD0) + required: true + - type: textarea + attributes: + label: Translation + description: Please translate the labels on the right, e.h. "Copy to clipboard", etc. + value: |- + {% macro t(key) %}{{ { + "language": "en", + "direction": "ltr", + "clipboard.copy": "Copy to clipboard", + "clipboard.copied": "Copied to clipboard", + "edit.link.title": "Edit this page", + "footer.previous": "Previous", + "footer.next": "Next", + "footer.title": "Footer", + "header.title": "Header", + "meta.comments": "Comments", + "meta.source": "Source", + "nav.title": "Navigation", + "search.config.lang": "en", + "search.config.pipeline": "trimmer, stopWordFilter", + "search.config.separator": "[\s\-]+", + "search.placeholder": "Search", + "search.reset": "Clear", + "search.result.initializer": "Initializing search", + "search.result.placeholder": "Type to start searching", + "search.result.none": "No matching documents", + "search.result.one": "1 matching document", + "search.result.other": "# matching documents", + "search.result.more.one": "1 more on this page", + "search.result.more.other": "# more on this page", + "search.result.term.missing": "Missing", + "select.language.title": "Select language", + "select.version.title": "Select version", + "skip.link.title": "Skip to content", + "source.link.title": "Go to repository", + "source.file.date.updated": "Last update", + "source.file.date.created": "Created", + "tabs.title": "Tabs", + "toc.title": "Table of contents", + "top.title": "Back to top" + }[key] }}{% endmacro %} + render: jinja + validations: + required: true