diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 905543bf23..88f832447a 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -10,6 +10,8 @@ Please confirm you have... + + ## Problem Description diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ba26ddc86f..648feddd92 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,11 @@ - + ## Description ## Checklist: + - [ ] **I am associating a language with a new file extension.** - [ ] The new extension is used in hundreds of repositories on GitHub.com @@ -41,10 +42,16 @@ - Old: https://github-lightshow.herokuapp.com/ - New: https://github-lightshow.herokuapp.com/ - + - [ ] **I am updating a grammar submodule** - [ ] **I am adding new or changing current functionality** - [ ] I have added or updated the tests for the new or changed functionality. + +- [ ] **I am changing the color associated with a language** + + - [ ] I have obtained agreement from the wider language community on this color change. + - [URL to public discussion] + - [Optional: URL to official branding guidelines for the language] \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d41f47a31..13021118b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -157,6 +157,18 @@ If problems are found, please report these problems to the grammar maintainer as Please then open a pull request for the updated grammar. +## Changing the color associated with a language + +Many of the colors associated with the languages within Linguist have been in place for a very long time. +The colors were often chosen based on the colors used by the language at the time and since then users will have become familiar with those colors as they appear on GitHub.com. +If you would like to change the color of a language, we ask that you propose your suggested color change to the wider community for your language to gain consensus before submitting a pull request. +Please do this in a community forum or repository used and known by the wider community of that language, not the Linguist repository. + +Once you've received consensus that the community is happy with your proposed color change, please feel free to open a PR making the change and link to the public discussion where this was agreed by the community. +If there are official branding guidelines to support the colour choice, please link to those too. + +Please note that Linguist currently implements a [color proximity test][] to ensure colors are sufficiently different from one another so you may not be able to use the precise color you want - reds and blues are really popular. +As such, we recommend you test the color change locally before making your plea to the wider language community. ## Testing @@ -227,5 +239,6 @@ If you are the current maintainer of this gem: [languages]: /lib/linguist/languages.yml [licenses]: https://github.com/github/linguist/blob/257425141d4e2a5232786bf0b13c901ada075f93/vendor/licenses/config.yml#L2-L11 [new-issue]: https://github.com/github/linguist/issues/new +[color proximity test]: https://github.com/github/linguist/blob/master/test/test_color_proximity.rb [samples]: /samples [search-example]: https://github.com/search?utf8=%E2%9C%93&q=extension%3Aboot+NOT+nothack&type=Code&ref=searchresults