Skip to content

Commit

Permalink
Add in docs .python-version and CHANGELOG.md files (#2411)
Browse files Browse the repository at this point in the history
* Add in docs .python-version and CHANGELOG.md files

* Update overview.rst

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

* Mentioned pyenv for the .python-version file

* Fix lint error: D001 Line too long

---------

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
  • Loading branch information
sgaynetdinov and sobolevn authored Dec 30, 2023
1 parent 5b8b33c commit 1831107
Showing 1 changed file with 9 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ root project
It basically defines what to do with your project
after pushing it to the repository. Currently it is used for testing
and releasing a ``docker`` image
- ``.python-version`` - file that specifies the Python version
to be used for the project, particularly when using `pyenv`.
This file helps in maintaining a consistent Python environment
across different machines and environments
- ``CHANGELOG.md`` - file that contains a chronological
log of all notable changes made to the project. It provides
a comprehensive overview of the project's evolution and
helps users and contributors understand the development history
- ``docker-compose.yml`` - this the file specifies ``docker`` services
that are needed for development and testing
- ``docker-compose.override.yml`` - local override for ``docker-compose``.
Expand Down Expand Up @@ -93,6 +101,7 @@ docker
tests
~~~~~

- ``tests/plugins`` - ``pytest`` plugins that are used in this project
- ``tests/test_server`` - tests that ensures that basic ``django``
stuff is working, should not be removed
- ``tests/test_apps/test_main`` - example tests for the ``django`` app,
Expand Down

0 comments on commit 1831107

Please sign in to comment.