@@ -28,6 +28,7 @@ To help us review your changes quickly and accurately, please follow these guide
2828 be squashed and merged with the pull request title and number as the commit message.
29292 . Complete the pull request template, including any relevant details about your changes and any associated issues.
3030
31+ * Be sure to use the official template. Do not use AI-generated PR summaries that completely replace our template.
3132 * Leave the template comments in place. They are helpful when editing the PR description.
3233
3334 ``` markdown
@@ -88,7 +89,7 @@ Here are some of the guidelines we follow:
8889- Each file, with few exceptions, should end with an empty line.
8990- In most cases, the maximum line length should not exceed 120 characters to make the code more readable.
9091- We use [ yamllint] ( https://yamllint.readthedocs.io ) to lint our * yaml* files. You can find the configuration file
91- [ here] ( https://github.com/LizardByte/.github/blob/master/yamllint-config .yml ) in our * .github* repository.
92+ [ here] ( https://github.com/LizardByte/.github/blob/master/. yamllint.yml ) in our * .github* repository.
9293- We use [ CodeQL] ( https://codeql.github.com/ ) and [ SonarCloud] ( https://sonarcloud.io/ ) to analyze our codebases.
9394 There will be a comment on your PR indicating if there are any issues that need to be addressed.
9495 Please address these issues if reasonable.
@@ -110,6 +111,7 @@ contributions must meet our quality standards.
110111- Code refactoring suggestions that you carefully review and understand
111112
112113#### Unacceptable AI Usage
114+ - AI generation of PR description/summary, use our standard PR template
113115- Submitting code you don't fully understand
114116- Generating entire features or components without significant human oversight
115117- Using AI to create code without properly testing it
@@ -126,13 +128,19 @@ Testing is a critical part of our development process, and we have automated tes
126128meets the expected quality and functionality.
127129
128130#### Code Style Tests
129- To ensure consistent code style, we run automated tests on pull requests. The tests that run depend on the labels of
130- the repository. The following table shows the labels and the corresponding tests that will run:
131-
132- | Label | Checks |
133- | ----------| ------------------------------|
134- | ` python ` | ` flake8 ` |
135- | ` c++ ` | ` clang-format ` , ` cmake-lint ` |
131+ To ensure consistent code style, we run automated tests on pull requests. The tests that run depend on the language(s)
132+ of the repository. The following table shows the labels and the corresponding tests that will run:
133+
134+ | Language | Checks |
135+ | ------------------------------------| --------------------------|
136+ | ` c ` , ` c++ ` | clang-format, cmake-lint |
137+ | ` docker ` | hadolint |
138+ | ` github-action ` , ` github-workflow ` | actionlint |
139+ | ` jupyter ` , ` python ` | flake8 |
140+ | ` PowerShell ` | PSScriptAnalyzer |
141+ | ` rust ` | rustfmt |
142+ | ` shell ` | shellcheck |
143+ | ` yaml ` | yamllint |
136144
137145Projects may have additional checks, ` eslint ` for example, depending on the project's requirements.
138146
0 commit comments