Skip to content

Commit

Permalink
Add PR, Bug and Feature templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Johandry Amador authored and Johandry Amador committed Aug 13, 2020
1 parent dc74afe commit 7a6e681
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: ""
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (if apply):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
- Device: [e.g. iPhone6]

**Additional context**
Add any other context about the problem here.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[Feature] "
labels: feature request
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Or, the use case of this feature. Ex: This feature will help us to [...]
Please keep this section focused on the problem and not on the suggested solution.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Proposal**
If you have an idea about how to address the problem via a change features or code, please, describe it here.

**Additional context**
Add any other context or screenshots about the feature request here.

**References**
List any other GitHub issues, whether open or closed, that are related to the problem you've described above or to the suggested solution. For example:

- #6017
34 changes: 34 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Pull request
about: Help us improve our package
title: "[WIP|Feature|Fix]"
labels: do-not-merge
---

**Community Note**
Pull requests are always welcome, we are always thrilled to receive them and we do our best to process them quickly. If your pull request is not accepted on the first try, don't get discouraged!

- Please vote on this pull request by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
- Ensure you have added or ran the appropriate tests for this pull request
- If the PR is unfinished, add `[WIP]` prefix to the pull request title and add the `do-not-merge` label.
- Include in the title the category of this pull request. The categories are: `[WIP]`, `[Feature]` or `[Fix]`. If the category is unknown use `[WIP]`, once the PR is ready to be merged replace `[WIP]` for the right category.
- Always assign label(s) to your PR.
- Any significant improvement should be documented as [a GitHub issue](https://github.com/IBM/cloud-enterprise-examples/issues) before anybody starts working on it.
- Make sure all your commits include a signature generated with `git commit -s`

**What this PR does / Why we need it?**

**References**
List of issues this PR fixes using the prefix `Fixes`, `Closes` or `Resolves` and the issue number or link. Format Examples: `Fixes #<issue number>`, `Closes <link of issue>` or `Resolves #<issue number>`.
The issues will be closed automatically when this pull request is merged. Example:

- Fixes #000

**How I did it?**
Description of the changes done.

**How to verify it?**
Instructions to test the change. Include screenshot or test output as evidence or as example of expected results for the tests.

**Description for the changelog**
Write a short (one line) summary that describes the changes in this pull request for inclusion in the changelog

0 comments on commit 7a6e681

Please sign in to comment.