From 63142a1112a4e132610cd0e8ae43dfc5fa58104d Mon Sep 17 00:00:00 2001 From: Supriya Date: Sun, 6 Oct 2024 12:37:04 +0530 Subject: [PATCH] Add formatting steps to the pull request template --- .github/pull_request_template.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d9cc4c3c35c5..71f203108aa4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,4 +13,11 @@ In order to reduce the number of notifications sent to the maintainers, please: - [ ] All filenames are in PascalCase. - [ ] All functions and variable names follow Java naming conventions. - [ ] All new algorithms have a URL in their comments that points to Wikipedia or other similar explanations. -- [ ] All new code is formatted with `clang-format -i --style=file path/to/your/file.java` \ No newline at end of file +- [ ] All new code is formatted with `clang-format -i --style=file path/to/your/file.java` + +# Formatting Steps +Please ensure your code follows these formatting steps before submitting your pull request: + +- Run the code through [Black](https://black.readthedocs.io/en/stable/) for consistent code formatting. +- Use [Flake8](https://flake8.pycqa.org/en/latest/) to check for style guide enforcement and linting. +- Make sure all tests pass before submitting the pull request.