📚 Add package documentation #37
Merged
Conversation
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
- Added a new file with guidelines on getting started, running tests, code style, pre-commit hooks, submitting pull requests, and reporting issues. - Added a ============================= test session starts ============================= platform win32 -- Python 3.8.10, pytest-8.3.2, pluggy-1.5.0 django: version: 4.2.14, settings: kernel.settings (from ini) rootdir: D:\GitHub\SAGE\DjangoIranianCities\django-iranian-cities configfile: pyproject.toml testpaths: tests plugins: cov-5.0.0, django-4.8.0 collected 26 items tests\admin\test_formfield.py . [ 3%] tests\models\test_code.py ...... [ 26%] tests\models\test_code_unique.py ...... [ 50%] tests\models\test_str.py ...... [ 73%] tests\settings\test_admin_permissions.py ... [ 84%] tests\settings\test_checks.py .... [100%] ---------- coverage: platform win32, python 3.8.10-final-0 ----------- Name Stmts Miss Cover Missing --------------------------------------------------------------------------- iranian_cities\__init__.py 0 0 100% iranian_cities\admin.py 76 0 100% iranian_cities\checks.py 25 5 80% 62, 69-72 iranian_cities\conf.py 18 0 100% iranian_cities\constants.py 2 0 100% iranian_cities\exc.py 24 0 100% iranian_cities\management\__init__.py 0 0 100% iranian_cities\mixins\__init__.py 3 0 100% iranian_cities\mixins\base_inline.py 4 0 100% iranian_cities\mixins\base_location.py 11 0 100% iranian_cities\mixins\dynamic_permission.py 23 0 100% iranian_cities\models.py 54 0 100% tests\__init__.py 0 0 100% tests\admin\__init__.py 0 0 100% tests\admin\test_formfield.py 26 0 100% tests\conftest.py 10 0 100% tests\constants.py 2 0 100% tests\models\__init__.py 0 0 100% tests\models\test_code.py 36 0 100% tests\models\test_code_unique.py 34 0 100% tests\models\test_str.py 36 0 100% tests\settings\__init__.py 0 0 100% tests\settings\test_admin_permissions.py 41 0 100% tests\settings\test_checks.py 44 0 100% --------------------------------------------------------------------------- TOTAL 469 5 99% Coverage HTML written to dir htmlcov ============================= 26 passed in 2.54s ============================== guide for writing tests with details on file structure, class and function naming conventions, markers, docstrings, type annotations, and using fixtures. - Updated general documentation to reflect new guidelines and improved structure. - Enhanced sections on running tests and code quality tools to align with the latest practices. These updates aim to provide clear instructions for contributors and ensure consistency in code contributions and testing practices.
- Added a new CONTRIBUTING.md file with guidelines on getting started,
running tests, code style, pre-commit hooks, submitting pull requests,
and reporting issues.
- Added a pytest guide for writing tests with details on file
structure, class and function naming conventions, markers,
docstrings, type annotations, and using fixtures.
- Updated general documentation to reflect new guidelines and
improved structure.
- Enhanced sections on running tests and code quality tools to
align with the latest practices.
These updates aim to provide clear instructions for contributors
and ensure consistency in code contributions and testing
practices.
…D/django-iranian-cities into doc/package-documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
CONTRIBUTING.mdfile with guidelines on getting started, running tests, code style, pre-commit hooks, submitting pull requests, and reporting issues.pytestguide for writing tests with details on file structure, class and function naming conventions, markers, docstrings, type annotations, and using fixtures.These updates aim to provide clear instructions for contributors and ensure consistency in code contributions and testing practices.