CONTRIBUTING.md

Contributing

Contributions are encouraged! Please use the issue page to submit feature requests or bug reports. Issues with attached PRs will be given priority and have a much higher likelihood of acceptance. Please also open an issue and associate it with any submitted PRs.

Installation

slm uses Poetry for environment, package and dependency management:

    poetry install

Documentation

slm documentation is generated using Sphinx with the readthedocs theme. Any new feature PRs must provide updated documentation for the features added. To build the docs run:

cd ./doc
poetry run doc8 --ignore-path build --max-line-length 100
poetry run make html

Static Analysis

slm uses ruff for linting and code formatting. Before any PR is accepted the following must be run, and static analysis tools should not produce any errors or warnings. Disabling certain errors or warnings where justified is acceptable:

    poetry run ruff format slm
    poetry run ruff check --fix --select I slm
    poetry run ruff check slm
    poetry check
    poetry run pip check
    poetry run safety check --full-report
    poetry run python -m readme_renderer ./README.md

Running Tests

slm is setup to use pytest to run unit tests. All the tests are housed in slm/tests/tests.py. Before a PR is accepted, all tests must be passing.

To run the full suite:

    poetry run pytest

To run a single test, or group of tests in a class:

    poetry run pytest <path_to_tests_file>::ClassName::FunctionName

For instance to run all tests in TestDjangoEnums, and then just the test_properties_and_symmetry test you would do:

    poetry run pytest slm/tests/tests.py::TestLegacyParser
    poetry run pytest slm/tests/tests.py::TestLegacyParser::test_AAA200USA