When submitting an issue, please follow these instructions:
- Search for issues similar to yours in GitHub search.
- Feature requests are welcome; simply add an issue with a clear definition of what you think will make cfn-lint better.
- If there's an open issue, please contribute to that issue.
- If there's a closed issue, open a new issue and link the url of the already closed issue(s).
- If there is no issue, open a new issue and specify the following:
- A short description of your issue in the title
- The cloudformation template used
- Detailed explanation of how to recreate the issue
- If you are experiencing more than one problem, create a separate issue for each one. If you think they might be related, please reference the other issues you've created.
Ideally, all code contributions should be accompanied by functional and/or unit tests (as appropriate). You can see a number of the current tests written in the test directory. As this is a validation tool you should aim for a minimum of 2 tests per feature:
- One which causes the template validation to fail
- One which causes the template validation to succeed
Each test should have it's own Cloudformation file, either JSON or YAML and should be named clearly about the test it should
fail, for example 1_ref_not_string_param.json. If your feature has many possible failure scenarios, please create tests for all of these.
- If you don't know how to fork and PR, see here.
- Fork the repo and create a new branch based from the master branch
- Write your code
- Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, add some tests!
- Make the tests pass and make sure you follow our syntax guidelines.
- Push to your fork and submit a pull request to the appropriate branch, the CI will hopefully confirm all the tests pass!