issues
search
mitre
/
canonical-ubuntu-18.04-lts-stig-baseline
(WIP) canonical-ubuntu-18.04-lts-stig-baseline
Other
9
stars
4
forks
source link
add docs on how we want folks to submit PRs
#8
Open
aaronlippold
opened
3 years ago
aaronlippold
commented
3 years ago
For example:
Development
Submitting a PR
A complete PR should include 7 core elements:
A signed PR ( aka git commit -a -s )
Code for the new functionality
Updates to the CLI
New unit tests for the functionality
Updates to the docs and examples in README.md and ./docs/*
(if needed) Example / Template files ( metadata.yml,example.yml, etc )
Scripts / Scaffolding code for the Example / Template files ( generate_map is an example )
Example Output of the new functionality if it produces an artifact
Overview of our PR process.
open an issue on the main inspec_tools website noting the issues your PR will address
fork the repo
checkout your fork
cd to the repo
git co -b
bundle install
hack as you will
test via rake
ensure unit tests still function and add unit tests for your new feature
add new docs to the README.md and to ./docs/examples
update the CLI as needed and add in usage example
(if needed) create and document any example or templates
(if needed) create any supporing scripts
(opt) gem build inspec_tools.gemspec
(opt) gem install inspec_tools
(opt) test via the installed gem
git commit -a -s
Open a PRs aginst the MITRE inspec_tools repo
For example:
Development
Submitting a PR
Overview of our PR process.