Create NEW_LANGUAGE.MD

This commit is contained in:
Alastair Mooney 2024-09-25 14:04:17 +01:00 committed by GitHub
parent 62db8cb3f3
commit dbb18918f5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -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!