From dbb18918f5b647aac605483371b9acb982406500 Mon Sep 17 00:00:00 2001 From: Alastair Mooney Date: Wed, 25 Sep 2024 14:04:17 +0100 Subject: [PATCH] Create NEW_LANGUAGE.MD --- .github/PULL_REQUEST_TEMPLATE/NEW_LANGUAGE.MD | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/NEW_LANGUAGE.MD diff --git a/.github/PULL_REQUEST_TEMPLATE/NEW_LANGUAGE.MD b/.github/PULL_REQUEST_TEMPLATE/NEW_LANGUAGE.MD new file mode 100644 index 0000000..87447f8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/NEW_LANGUAGE.MD @@ -0,0 +1,27 @@ +# New Language Definition Contribution + +Thank you for contributing a new language definition! Please follow the guidelines below to ensure that your contribution can be easily reviewed and integrated into the project. + +--- + +## Description + +- **Language Name**: (e.g., Python, JavaScript) + +Fixes # (issue number, if applicable) + +--- + +## Checklist for Adding a New Language** + +Before submitting your pull request, please ensure the following requirements are met: + +- [ ] I have added the language to `syntax.json` with the language name matching that in GitHub's [Linguist `languages.yml` file](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml). +- [ ] I have added sample code to `test_new.diff` and `test_closed.diff`. +- [ ] I have added issue creation and closure tests to `test_todo_parser.py`. The test should check that the `ace_mode` of the issue matches that specified in the `languages.yml` file. If an existing check for that `ace_mode` exist, I have incremented that instead. +- [ ] I have updated the README to add the language. +- [ ] I have run and verified all tests. + +## Thank You! + +We appreciate your time and effort in improving this project!