First off, thank you for considering contributing to this repository! This resource is a very simple project, but I am sure it has plenty of room for improvement.
If you're just looking for quick feedback for an idea or proposal, feel free to open an issue.
Follow the contribution workflow for submitting your changes.
This project uses the “fork-and-pull” development model. Follow these steps if you want to merge your changes into the project:
- Within your fork of spingo, create a branch for your contribution and use a meaningful name.
- Create your contribution, meeting all contribution quality standards.
- Create a pull request against the master branch.
- Once the pull request is approved, one of the maintainers will merge it and build a release if needed.
Your contribution needs to meet the following standards:
- All files and folders in spingo are
kebab-case- any new additions to spingo must follow this convention unless an exception is noted. - Separate each logical change into its own commit.
- Add a descriptive message for each commit. Follow commit message best practices.
- Document your pull requests. Include the reasoning behind each change and describe the testing done.
- To the extent possible, follow existing code and documentation style and practices.
- Each contribution must pass a shellcheck and terraform validate test.