Include local development instructions in README
Open
- Dominant language
- Python
- Stars
- 7
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
To assist Platform Services Team developers working with AppAssessment, add details about how local development should work in the README.
Include:
- What permissions are needed in a given OpenShift namespace to run AppAssessment successfully?
- What does the AppAssessment installation command look like if you want to generate a report using local changes?
- Ex: `python3 ./build/report.py -n -o ./build/report.html`
- How should you install the Python dependencies locally?
- Ex: Does `./build/requirements.txt` file need to be used?
**Definition of done**
- [ ] `./README.md` is updated to include the information above.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.