Skip to content

Add test running instructions to README#107

Open
zache-fi wants to merge 1 commit intomainfrom
zache-fi-patch-1
Open

Add test running instructions to README#107
zache-fi wants to merge 1 commit intomainfrom
zache-fi-patch-1

Conversation

@zache-fi
Copy link
Copy Markdown
Collaborator

@zache-fi zache-fi commented Apr 8, 2026

Added instructions for running tests in README.

What type of PR is this? (check all applicable)

  • 📝 Documentation Update

Tested?

  • 👍 yes

Added to documentation?

  • 📜 README.md

Added instructions for running tests in README.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation to help contributors run the project’s test suite locally.

Changes:

  • Introduces a new README section describing how to set up an environment and run tests.
  • Provides a unittest discovery command for executing tests under test/.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ukbot --page Bruker:Danmichaelo/Sandkasse5 --simulate config/config.no-mk.yml


## Howto run tests
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heading "Howto run tests" is grammatically incorrect/inconsistent with other sections (e.g., "Getting Started"). Consider renaming to "How to run tests" for clarity and consistency.

Suggested change
## Howto run tests
## How to run tests

Copilot uses AI. Check for mistakes.
Comment on lines +67 to +68
python3 -m venv venv
source venv/bin/activate
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These test instructions create/activate a different virtualenv path ("venv/") than the one used in "Getting Started" ("www/python/venv"). This is likely to confuse contributors; consider reusing the same path (or explicitly stating that the existing env from Getting Started can be reused) and using the same activation command style (". /bin/activate" vs "source").

Suggested change
python3 -m venv venv
source venv/bin/activate
python3 -m venv www/python/venv
. www/python/venv/bin/activate

Copilot uses AI. Check for mistakes.
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install .
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI config (.travis.yml) currently runs tests via "pytest -v", but README instructs using "python3 -m unittest discover". Since this repository's tests are compatible with both, consider aligning the README with the CI command (or mention both options) to reduce confusion when reproducing CI locally.

Suggested change
pip install .
pip install .
pytest -v
If you prefer the standard library test runner, the test suite is also compatible with:

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants