Add common pitfalls section to AGENTS.md for testing guidelines
This commit is contained in:
@@ -37,6 +37,11 @@ As an HTML templating engine, you can use Jinja2, which is built into Flask, for
|
|||||||
11. TDD: Write a single integration test that will consist of downloading few video urls. It should query these videos over proxy and check if it works properly (yt-dlp is fully capable substitute for a browser that can be configured to output all necessary debug inforation, such as headers and cookies). Also write tests for critical functions like URL parsing, caching, playlist and segment proxying, and error handling. All test should be in `tests/` folder and use `pytest` as a testing framework. All tests should generate maximum debugging output to make it easy to understand what went wrong in case of failure.
|
11. TDD: Write a single integration test that will consist of downloading few video urls. It should query these videos over proxy and check if it works properly (yt-dlp is fully capable substitute for a browser that can be configured to output all necessary debug inforation, such as headers and cookies). Also write tests for critical functions like URL parsing, caching, playlist and segment proxying, and error handling. All test should be in `tests/` folder and use `pytest` as a testing framework. All tests should generate maximum debugging output to make it easy to understand what went wrong in case of failure.
|
||||||
12. Documentation and license: only `README.md`, `AGENTS.md` and MIT license.
|
12. Documentation and license: only `README.md`, `AGENTS.md` and MIT license.
|
||||||
|
|
||||||
|
### Common Pitfalls
|
||||||
|
|
||||||
|
1. Do not disable tests or skip critical paths. If something is not working, fix it instead of skipping tests.
|
||||||
|
2. Do not create workarounds. They are not allowed. If something is not working, fix it instead of creating a workaround.
|
||||||
|
|
||||||
### Project Structure
|
### Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user