Skip to content

Commit 63142a1

Browse files
committed
Add formatting steps to the pull request template
1 parent 07cb6c4 commit 63142a1

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

.github/pull_request_template.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,11 @@ In order to reduce the number of notifications sent to the maintainers, please:
1313
- [ ] All filenames are in PascalCase.
1414
- [ ] All functions and variable names follow Java naming conventions.
1515
- [ ] All new algorithms have a URL in their comments that points to Wikipedia or other similar explanations.
16-
- [ ] All new code is formatted with `clang-format -i --style=file path/to/your/file.java`
16+
- [ ] All new code is formatted with `clang-format -i --style=file path/to/your/file.java`
17+
18+
# Formatting Steps
19+
Please ensure your code follows these formatting steps before submitting your pull request:
20+
21+
- Run the code through [Black](https://black.readthedocs.io/en/stable/) for consistent code formatting.
22+
- Use [Flake8](https://flake8.pycqa.org/en/latest/) to check for style guide enforcement and linting.
23+
- Make sure all tests pass before submitting the pull request.

0 commit comments

Comments
 (0)