mesonbuild/meson

Document how to run the project tests, the unit tests, and both together

Closed

#2,818 opened on Dec 22, 2017

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (1,465 forks)batch import
CIdocumentationgood first issuehelp wantedmeson tests

Repository metrics

Stars
 (4,978 stars)
PR merge metrics
 (Avg merge 139d 13h) (51 merged PRs in 30d)

Description

Must document:

  • That CI runs on Appveyor (and what platforms, with a link to https://ci.appveyor.com/project/jpakkane/meson/history) and Travis (link to https://travis-ci.org/mesonbuild/meson/builds)
  • ./run_tests.py runs all tests, including cross-tests on Ubuntu (which we need to extend to other distros)
  • ./run_project_tests.py runs project tests, what their purpose is, and the fact that right now you cannot run each individually (we should also fix that)
  • ./run_unittests.py runs unit tests, which ones run on which platform (so people know where to put new tests), how to run individual unit tests

More.

Contributor guide

Research direction
Review the existing test scripts (run tests.py, run project tests.py, run unittests.py) and CI configuration files (appveyor.yml, .travis.yml) to document the test execution process. Also check the current documentation in the repository to ensure accuracy and identify missing details.
Tech stack
python
Domain
build systemdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80