diff --git a/ISSUE_TEMPLATE/bug_report.md b/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..5ff14a1 --- /dev/null +++ b/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: '' +assignees: '' + +--- + +**Describe the bug** + +**Steps to reproduce the behavior:** +1. Starting with '...' +2. Then doing '....' +3. Detecting the error '....' + +**Expected behavior** + +**Screenshots, if applicable** + +**Environment (Hardware / Software and Versions):** + +**Anything else** diff --git a/ISSUE_TEMPLATE/feature_request.md b/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..8419380 --- /dev/null +++ b/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[Feature]" +labels: '' +assignees: '' + +--- + +**Describe the solution you'd like** + +**If your feature request is related to a problem, please describe.** + +**What alternatives have you considered** + +**Anything else** diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..27ff1a7 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,3 @@ + + +I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8808e40 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +This .github repository contains default files that apply to the projects in this organization. diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..8f85642 --- /dev/null +++ b/contributing.md @@ -0,0 +1,22 @@ +# How to contribute +First, thanks for taking the time to contribute to our project! There are many ways you can help out. + +### Questions + +If you have a question that needs an answer, [create an issue](https://help.github.com/articles/creating-an-issue/), and label it as a question. + +### Issues for bugs or feature requests + +If you encounter any bugs in the code, or want to request a new feature or enhancement, please [create an issue](https://help.github.com/articles/creating-an-issue/) to report it. Kindly add a label to indicate what type of issue it is. + +### Contribute Code +We welcome your pull requests for bug fixes. To implement something new, please create an issue first so we can discuss it together. + +***Creating a Pull Request*** +Please follow [best practices](https://github.com/trein/dev-best-practices/wiki/Git-Commit-Best-Practices) for creating git commits. + +When your code is ready to be submitted, [submit a pull request](https://help.github.com/articles/creating-a-pull-request/) to begin the code review process. + +We only seek to accept code that you are authorized to contribute to the project. We have added a pull request template on our projects so that your contributions are made with the following confirmation: + +> I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.