[Bug]: BUILDING.md does not explain the test targets, APP_ROOT, or the effects of running the integration tests

Open Beginner friendly
#2,287 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
build-system, documentation, testing-qa

Research direction

Open BUILDING.md and start with the “Compile and test” section and its make APP_ROOT=test-data all test integration command. Explain what make all, make test, and make integration do, the need to build before integration tests, and how APP_ROOT affects and protects application data; done means the commands and data-erasure behavior are clear to readers.

Written by the indexing model from the issue text.

Description

I have done the following
  • I have searched the existing issues
  • If possible, I've reproduced the issue using the 'main' branch of this project
Steps to reproduce

BUILDING.md

Problem description

BUILDING.md's "Compile and test" section gives a single command, make APP_ROOT=test-data all test integration, without explaining:

  • what make all, make test, and make integration each do, or that make integration
    runs bin/container and therefore needs make all first
  • what APP_ROOT is for, that make integration erases its contents before each run, and
    that leaving it unset makes the integration tests operate on the user's real application
    data directory
Environment
- OS: 26.6.2
- Xcode: 27.0
- Container: 1.2.0
Code of Conduct
  • I agree to follow this project's Code of Conduct
Dominant language
Swift
Stars
50.1k
Forks
1.8k
Avg merge
2d 2h
Merged PRs (30d)
19

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apple/container

All issues in apple/container

Similar issues

More Swift issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.