vyanitskiy
/
highlight.js
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

(chore) update issue templates, pass 3

This commit is contained in:
Josh Goebel 2021-04-13 04:24:48 -04:00
parent e41af5d427
commit a493e01792
3 changed files with 7 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
.github/ISSUE_TEMPLATE/0_language-request.md vendored
View File

@ -1,42 +0,0 @@
---
name: Request a new language
about: Highlight.js should add support for a new language.
title: PLEASE read the below carefully.
labels: autoclose
assignees: ''
---
First let us say that we'd also love it if Highlight.js could highlight whichever language you're about to request support for! And there is a chance you can help make that happen! But first...
...PLEASE READ THE FOLLOWING...
Highlight.js does not have a fundamental plan for implementing new languages
- i.e., the core team doesn't usually develop new languages. The core team
instead focuses on parser development, bugs, and supporting the existing
languages. They also currently does not have time to review, merge and
maintain any additional languages (fixing bugs, dealing with issues, etc).
Instead, the project works by encouraging 3rd party language grammars from
contributors willing to help develop and maintain them. We're also happy to
host those 3rd party language grammars at the ``highlightjs`` GitHub
organization - no matter how obscure or weird. Or you're wlecome to host it
yourself - we're still happy to link to it.
This means that *there's no point in requesting a new language without also
providing a 3rd party implementation* (we'll simply close "Please support
language Xyz" issues with a link to this explanation). If you'd like to see
a particular language available but cannot implement it, the best way to
make it happen is to find another developer interested in doing so.
For more info on actually developing a language see our :doc:`language-guide`,
and for information on how to properly package your 3rd party language module
see :doc:`language-contribution`.
If you are interested in contributing a 3rd party language grammar you can start with:
- https://highlightjs.readthedocs.io/en/latest/language-contribution.html
---
You actually don't need to create this issue at all unless you have a specific question about the 3rd party language grammar creation process - which we'd be glad to answer.

7
.github/ISSUE_TEMPLATE/config.yml vendored
View File

@ -1,8 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Join the Highlight.js Discord community
- name: Join our friendly Discord community
url: https://discord.gg/M24EbU7ja9
about: We're friendly and helpful and we'd be happy to have you.
about: If you'd like to hang out, help out, or need some help - we're here.
- name: Read our documentation
url: https://highlightjs.readthedocs.io/
about: Sometimes the answers are right there, just waiting to be discovered.
- name: Request a new language
url: https://highlightjs.readthedocs.io/en/latest/language-requests.html
about: Please read our policy on requesting new languages.

4
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -1,6 +1,6 @@
---
name: Request a new feature
about: You'd like to suggest a potentially helpful new feature...
name: Request a new feature (other than a new language)
about: You'd like to suggest a potentially helpful new feature... for requesting languages look below.
title: "[Request] Short description of the new feature..."
labels: enhancement, parser
assignees: ''