CONTRIBUTING.md

Contributing Guide

To contribute, please follow these steps:

1. Fork the mkdocs-exclude-unused-files repository on GitHub.

2. Create a new branch for your feature or bug fix.

3. Setup development environment.

   # install pipx
   python3 -m pip install --user pipx
   pipx ensurepath
   
   # install poetry + plugins
   pipx install poetry
   pipx inject poetry poetry-plugin-up
   pipx inject poetry poetry-dynamic-versioning
   
   # install project dependencies
   poetry install
   
   # bump dependencies to the latest
   poetry up --latest
   
   # do test build
   poetry build

4. Make your changes

5. Test your changes in the test directory

   cd test/fixtures
   pip install ../.. && mkdocs build --verbose

6. Lint and validate your code

   poetry run pre-commit run --all-files

7. Commit your changes.

8. Make sure the README.md and any other relevant documentation are kept up-to-date.

9. Push to your forked repository.

10. Create a new pull request from your fork to this project.

11. Please ensure that your pull request includes a detailed description of your changes.