Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 3.16 KB
Raw

How to contribute

This project originated as an engine for driving the AMIgen6 and AMIgen7 tool-sets. The initial objective was to ease and speed the creation of AWS AMIs so that the task:

  • could be turned over to less-experienced staff
  • increase the velocity of AMI-releases
  • increase the AMI release-proliferations (addition of RHEL to the original CentOS-focused releases)
  • increase the number of AWS regions supported (from just us-east-1 to all of the CONUS regions - including GovCloud)

Since then, the objective has been expanded to include:

  • generation of VirtualBox images
  • generation of VMware templates
  • generation of Azure images
  • generation of OpenStack images
  • publishing of VirtualBox and VMware images to Vagrant Cloud

Where all of the above images are notionally-identical but for their respective deployment contexts. "Notionally-identical" also means that produced Red Hat and CentOS images' RPM-manifests and storage-layouts are the same within a given release-cycle.

The fruits of this automation-effort are openly provided on an "as-is" basis. Individuals who have stumbled on this project and find deficiencies in it are invited to help us enhance the project for broader usability. This can be done by opening issues against the project or, even better, offering enhancements via Pull Requests:

  • Please open an issue to identify "missing" deployment contexts
  • Please open pull requests - referencing the previously-opened issue - when ready to provide automation for new contexts.

Testing

In progress...

Currently, this project links to a couple of services. When submitting a PR:

  • Basic lints will be performed against any shell script
  • Basic lints will be performed against any Packer templates
  • Offered content will be tested by a CodeCommit pipeline that ensures that modifications continue to produce functional AMIs
  • Documentation will be tested for recency. Note: if the associated Travis CI job fails with a message like: 
    Error: spel/README.md is out of date
make: *** [/home/travis/build/plus3it/spel/tardigrade-ci/Makefile:463: docs/lint/spel/README.md] Error 1
The command "make -f Makefile.tardigrade-ci lint" exited with 2.
    It will be necesary to execute: 
    make -f Makefile.tardigrade-ci docs/generate
    In your branch's project-root (and then commit any changes) in order to clear it.

Submitting Changes

Please send a GitHub Pull Request with a clear list of what changes are being offered (read more about pull requests).

Please ensure that the commits bundled in the PR are performed with clear and concise commit messages. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Coding conventions

To be written...

  • Anything not otherwise specified - either explicitly as above or implicitly via pre-existing code - pick an element-style and be consistent with it .

Additonal Notes

To be written...