apache / apache/buildstream

Documentation: example on how to run `make check`, or `ninja test`, etc

Open
#1,784 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
140
Forks
45
Avg merge
1d 3h
Merged PRs (30d)
6

Description

Documentation: example on how to run `make check`, or `ninja test`, etc

To run the test suite of an element.

I could read in details the BuildStream documentation, and find the way to run these additional commands, but small examples would be handy.

Contributor guide

Open the contributing guide

Research direction

Start by locating the BuildStream documentation section covering how to run an element's test suite. Add small examples for commands such as `make check` and `ninja test`, and confirm that the examples clearly explain how to run these additional commands.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.