Contributing

You can contribute to the template library in many ways:

• Modify README.md and add comments to existing template.yaml files to improve documentation
• Add or update template.yaml files to add new products coverage or improve template quality or depth
• Add or update test.sh files to add or improve test coverage for templates
• Add or update Dockerfile to enable or improve containerization support for products

Getting Started

You can make trivial changes to README.md or template.yaml comments directly on GitHub website using online editor.

For more elaborate changes you need to set up a local development environment.

Requirements:

1. Internet access
2. GitHub account
3. Docker engine for Linux, Mac or Windows
4. Bash shell, if you're on Windows. GitBash will work.

General process

1. Use the Fork button at the top right corner on this page to fork the project
2. Clone repository locally using Clone or download URL of your forked repository

git clone https://github.com/<YOUR_ACCOUNT>/sagdevops-templates.git
cd sagdevops-templates

3. Make any changes and test them locally
4. Commit to your forked repository

git commit -am “what i changed”
git push

5. Create a pull request against https://github.com/SoftwareAG/sagdevops-templates.git
6. Get the pull request reviewed and merged into the master branch

Thank you for your contributions!

Next: Setting up dev environment