diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..ae447db --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +# EditorConfig helps developers define and maintain consistent +# coding styles between different editors and IDEs +# editorconfig.org + +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space + +[*.{yml,yaml}] +indent_size = 2 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..1137db1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +##### Description + + + +##### Checklist + +- [ ] Tested functionality against a test repository (see ["How to test changes"](../README.md#how-to-test-changes)) +- [ ] Added or updated relevant documentation (leave unchecked if not applicable) diff --git a/README.md b/README.md index dadba0f..fda4674 100644 --- a/README.md +++ b/README.md @@ -45,3 +45,10 @@ git commit --amend --no-edit git push origin update_flake_lock_action --force ``` +## Contributing + +Feel free to send a PR or open an issue if you find something functions unexpectedly! Please make sure to test your changes and update any related documentation before submitting your PR. + +### How to test changes + +In order to more easily test your changes to this action, we have created a template repository that should point you in the right direction: https://github.com/DeterminateSystems/update-flake-lock-test-template. Please see the README in that repository for instructions on testing your changes.