From b895c6ace91612b98fb9c51b989ad9d6f52c827a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98ystein=20Bedin?= Date: Mon, 27 Aug 2018 18:51:23 -0400 Subject: [PATCH] Adding github specific files --- .github/CONTRIBUTING.md | 19 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..5d690a7 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# How to Contribute + +We welcome contributions from the community. Here are a few ways you can help us improve. + +## Open an Issue + +If you see something you'd like changed, but aren't sure how to change it, submit an issue describing what you'd like to see. + +## Submit a Pull Request + +If you feel like getting your hands dirty, feel free to make the change yourself. Here's how: + +1. Fork the repo on Github, and then clone it locally. +2. Create a branch named appropriately for the change you are going to make. +3. Make your code change. +4. Push your code change up to your forked repo. +5. Open a Pull Request to merge your changes to this repo. The comment box will be filled in automatically via a template. + +See [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) got more information on how to use GitHub PRs. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e2519c3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +### What does this PR do? +Brief explanation of the code or documentation change you've made + +### How should this be tested? +Automated tests are preferred, but not always doable - especially for infrastructure. Include commands to run your new feature, and also post-run commands to validate that it worked. (please use code blocks to format code samples) + +### Is there a relevant Issue open for this? +Provide a link to any open issues that describe the problem you are solving. +resolves # + +### Other Relevant info, PRs, etc. +Please provide link to other PRs that may be related (blocking, resolves, etc. etc.) + +### People to notify +cc: @redhat-cop/infra-ansible