Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
Fixed main reason for change
  'If you would like to contribute code'
  became
  'If you would like to contribute to the repository'
Changes to newlines in sections
  now using double space at end of line to 'newline'
Added "plugins" to source in command line test run instructions
  • Loading branch information
asgibson committed Oct 2, 2023
1 parent 38ac623 commit 72d8726
Showing 1 changed file with 19 additions and 26 deletions.
45 changes: 19 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# The On-board Artificial Intelligence Research (OnAIR) Platform

The On-board Artificial Intelligence Research (OnAIR) Platform is a framework that enables AI algorithms written in Python to interact with NASA's [cFS](https://github.com/nasa/cFS).
The On-board Artificial Intelligence Research (OnAIR) Platform is a framework that enables AI algorithms written in Python to interact with NASA's [cFS](https://github.com/nasa/cFS).
It is intended to explore research concepts in autonomous operations in a simulated environment.

## Generating environment
Expand Down Expand Up @@ -35,40 +35,32 @@ python driver.py -t

For the equivalent of the driver.py run:
```
python -m coverage run --branch --source=onair -m pytest ./test/
python -m coverage run --branch --source=onair,plugins -m pytest ./test/
```

#### Command breakdown:
`python -m` - invokes the python runtime on the library following the -m

`coverage run` - runs coverage data collection during testing, wrapping itself on the test runner used

`--branch` - includes code branching information in the coverage report

`--source=onair` - tells coverage where the code under test exists for reporting line hits

`-m pytest` - tells coverage what test runner (framework) to wrap

`./test` - run all tests found in this directory and subdirectories
`python -m` - invokes the python runtime on the library following the -m
`coverage run` - runs coverage data collection during testing, wrapping itself on the test runner used
`--branch` - includes code branching information in the coverage report
`--source=onair,plugins` - tells coverage where the code under test exists for reporting line hits
`-m pytest` - tells coverage what test runner (framework) to wrap
`./test` - run all tests found in this directory and subdirectories

#### A few optional settings
Options that may be added to the command line test run. Use these at your own discretion.

`--disable-warnings` - removes the warning reports, but displays count (i.e., 124 passed, 1 warning in 0.65s)

`--disable-warnings` - removes the warning reports, but displays count (i.e., 124 passed, 1 warning in 0.65s)
`-p no:randomly` - ONLY required to stop random order testing IFF pytest-randomly installed

### To view testing line coverage after run:
NOTE: you may or may not need the `python -m` to run coverage report or html

`coverage report` - prints basic results in terminal

`coverage report` - prints basic results in terminal
or

`coverage html` - creates htmlcov/index.html, automatic when using driver.py for testing

then

then
`<browser_here> htmlcov/index.html` - browsable coverage (i.e., `firefox htmlcov/index.html`)

## License and Copyright
Expand All @@ -77,13 +69,14 @@ Please refer to [NOSA GSC-19165-1 OnAIR.pdf](NOSA%20GSC-19165-1%20OnAIR.pdf) and

## Contributions

Please open an issue if you find any problems.
Please open an issue if you find any problems.
We are a small team, but will try to respond in a timely fashion.

If you would like to contribute code, GREAT!
First you will need to complete the [Individual Contributor License Agreement (pdf)](doc/Indv_CLA_OnAIR.pdf) and email it to [email protected] with [email protected] CCed.
If you would like to contribute to the repository, GREAT!
First you will need to complete the [Individual Contributor License Agreement (pdf)](doc/Indv_CLA_OnAIR.pdf).
Then, email it to [email protected] with [email protected] CCed.

Next, please create an issue for the fix or feature and note that you intend to work on it.
Fork the repository and create a branch with a name that starts with the issue number.
Once done, submit your pull request and we'll take a look.
You may want to make draft pull requests to solicit feedback on larger changes.
Next, please create an issue for the fix or feature and note that you intend to work on it.
Fork the repository and create a branch with a name that starts with the issue number.
Once done, submit your pull request and we'll take a look.
You may want to make draft pull requests to solicit feedback on larger changes.

0 comments on commit 72d8726

Please sign in to comment.