-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
116d6a5
commit 13f4b15
Showing
1 changed file
with
50 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
## Description | ||
|
||
<!-- | ||
Thank you for your contribution! Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. | ||
--> | ||
|
||
|
||
## Type of change | ||
|
||
<!-- Please select the options that are relevant. --> | ||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] Documentation update | ||
|
||
## How Has This Been Tested? | ||
|
||
<!-- Please describe the tests that you ran to verify your changes. Provide instructions so others can reproduce. Include details of your test environment, and the test cases you ran. | ||
- [ ] Test A | ||
- [ ] Test B | ||
--> | ||
- [ ] All pytest tests pass | ||
|
||
<!-- To run the tests, execute the following command from the root of the repository: | ||
```bash | ||
pytest | ||
``` | ||
--> | ||
|
||
|
||
## Linting and Code Formatting | ||
|
||
Make sure the code follows the project's linting and formatting standards. This project uses **Ruff** for linting. | ||
|
||
To run Ruff, execute the following command from the root of the repository: | ||
|
||
```bash | ||
ruff check . | ||
``` | ||
|
||
<!-- You can also fix some linting errors automatically using Ruff: | ||
```bash | ||
ruff check . --fix | ||
``` | ||
--> | ||
|
||
- [ ] Ruff passes |