← Back to issue list

Contributing documentation is not complete

View original Github issue

Metadata

Project
craft-providers
Number
#131
Type
issue
State
closed
Author
jugmac00
Labels
—
Created
Updated
Closed

Current evaluation

Resolved by adding HACKING.rst, restoring tox in #295, removing Makefile, and skipping sudo-dependent integration tests by default in merged #328.

Resolution: closed resolved

Reason: The maintainer closed #131 after documenting contribution setup and simplifying the workflow. Commit 9ebe593 restored tox via #295, and merged PR #328 marked sudo-dependent tests to skip by default.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Hi, I sadly saw that you deleted the tox configuration file. Instead of just running `tox -e py310` to run the tests, I now needed to figure out to run the tests. So I went to the README.md, found the following section... ``` ## Running tests To run all tests in the suite run: make tests ``` So I did as advised... ``` ❯ make tests black --check --diff setup.py craft_providers tests All done! ✨ 🍰 ✨ 81 files would be left unchanged. codespell setup.py craft_providers tests make: codespell: Command not found make: *** [Makefile:74: test-codespell] Error 127 ``` So, after that I checked the other make commands ... there must be one to set up the dev environment, right? No :-/ Next thing I read the Makefile... ok, there is really no command to set up a dev environment. Next I read `setup.py` and found the `test` and the `dev` extras, so I ... - created a virtual environment ``` virtualenv venv -p python3.10 ``` - installed the dev extras ``` pip install .[dev] ``` And finally was able to run the tests... ``` make tests .... ``` Though actually, this did not run the tests - at least not at the beginning, but the linters oO When I now want to build the docs, I cannot run `tox -e docs`, but I need to do the whole ceremony again :-/ As you clearly indicated that you do not like the tox workflow, it would be great though to make contributions a bit easier. You could either update the contribution documentation or create a make target which creates a dev environment. I am good now, but maybe you could smoothen the process for future contributors. Thanks for considering!

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Resolved by adding HACKING.rst, restoring tox in #295, removing Makefile, and skipping sudo-dependent integration tests by default in merged #328.
stealth/space-bunny-alpha — closed resolved Resolved by adding HACKING.rst, restoring tox in PR #295, removing the old Makefile, and skipping sudo-dependent tests by default via PR #328.
qwen/qwen3.6-35b-a3b — closed resolved Resolved by adding a HACKING.rst guide, restoring tox, and removing the Makefile to simplify the development environment setup for contributors.

Update history

Date Change
created

Related work

Related issues

Issue Project State Summary Similarity
#5033 docs: document tox builds snapcraft merged Merged #5033 in commit 8faa6d54e, documenting tox builds in HACKING.md and removing snapcraft_legacy from autobuild targets.
73%
#229 Move HACKING.rst to readthedocs starbase closed Resolved by merged PR #448 (commit ebfec44), replacing HACKING.md with a reusable CONTRIBUTING.md contribution guide.
70%