1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
# GitHub Copilot Instructions
This document provides essential guidance for AI agents contributing to pwdlib. Imagine this file as a new joiner to the team who needs to understand the coding standards, practices, and conventions used in this repository.
## General Guidelines
- Do not add comments to the code unless necessary. The code should be self-explanatory.
- Use meaningful variable and function names.
- Follow good practices and code conventions.
- Make sure that all the new code is maintanable and follows the SOLID principles.
- Do not modify unrelated code to the task or issue you are working on.
### Linting and testing
The project requires to be linted and type-checked. To do so, run:
```bash
just lint
```
Tests are located in the `tests/` directory. It uses `pytest` for testing. To run the tests, use:
```bash
just test
```
|
