mayr/test
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

moved CONTRIBUTING.md back up as it should be easy to find

Browse Source
This commit is contained in:
truePhilipp committed 2024-05-07 00:30:15 +02:00
1 parent d273b7b3ad
commit e8c02ccda8
2 files changed
+1 -1
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.github/CONTRIBUTING.md
-26
View File
@@ -1,26 +0,0 @@
# Contributing
If you want to contribute please do it like this:
1. Create a fork of the project
2. Perform the contribution on your fork
3. Create a pull request
## Testing
- All tests must be created in the `test` directory.
- The tests should be located in a package of the same name as the code it tests.
- The name of the file should be the same as the file of the code it tests, with a `tests_` prefix.
For example, the tests for `html_to_django/formatters/attr_formatter.py` are located in `tests/formatters/tests_attr_formatter.py`.
If you make changes to the code you need to make sure all the tests are still working. Use this command to run the tests:
```bash
python -m unittest discover tests --verbose
```
## Stylechecks
Follow established python coding guidelines. To check your code you can use these commands:
```bash
mypy --strict html_to_django
pycodestyle --max-line-length 120 html_to_django
```
Change `html_to_django` to `tests` to also check your tests.