Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GitHub Issue and Pull Request templates #60

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,47 @@
<!--
Please have a look at the issue templates you get when you click "New issue" in the GitHub UI.
We very much prefer issues created by using one of these templates.
Please select an appropriate issue template when you click "New issue" in the GitHub UI.
We would appreciate it if you could use one of the provided issue templates. Thank you!
-->

### Issue Type
<!-- Please check the boxes by putting an x in the [ ] like so: [x] -->
<!-- Please check the boxes by putting an `x` in the `[ ]` like so: `[x]` -->

- [ ] Bug Report
- [ ] Feature Request
- [ ] Support Question

## Description
<!-- Briefly describe an issue. -->



## Information
<!-- Include all relevant information that might help understand and reproduce the problem -->
<!-- Include all related information that might help understand and reproduce the problem. -->

### Command or Code
<!-- What command or code is needed to reproduce the problem? -->

### Environment, Platform, Device
<!-- In what environment, on what platform or on which device are you experiencing the issue? -->

### Command or Code
<!-- Describe a use case(s) that causes this problem. What command or code reproduces the problem? -->



### Version information
### Environment and Versions
<!--
What are relevant versions you are using?
Describe your environment, platforms, devices and Operating System.
Include all versions of Cordova tooling, Operating System, also Third-Party tools and programs.

For example:
Cordova: Cordova CLI, Cordova Platforms, Cordova Plugins
Other Frameworks: Ionic Framework and CLI version
Operating System, Android Studio, Xcode etc.
Cordova: Cordova CLI v0.0.0, Cordova Platform v0.0.0, Cordova Plugin v0.0.0
Other Tools/Frameworks: Ionic Framework 0.0.0 and Ionic CLI v0.0.0
Operating System, Android Studio, Xcode, etc.
-->



## Checklist
<!-- Please check the boxes by putting an `x` in the `[ ]` like so: `[x]` -->

- [ ] I searched for already existing GitHub issues about this
- [ ] I updated all Cordova tooling to their most recent version
- [ ] I included all the necessary information above
**Before submitting an issue, make sure to:**
- [ ] Update all Cordova tooling to their most recent version
- [ ] Search for already existing GitHub issues regarding your request
- [ ] Include all the necessary information above
29 changes: 13 additions & 16 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
name: 🐛 Bug Report
about: If something isn't working as expected.

---

# Bug Report
Expand All @@ -12,39 +11,37 @@ about: If something isn't working as expected.



### What does actually happen?
### What does happen?



## Information
<!-- Include all relevant information that might help understand and reproduce the problem -->
<!-- Include all related information that might help understand and reproduce the problem. -->



### Command or Code
<!-- What command or code is needed to reproduce the problem? -->


<!-- Describe a use case(s) that causes this problem. What command or code reproduces the problem? -->

### Environment, Platform, Device
<!-- In what environment, on what platform or on which device are you experiencing the issue? -->



### Version information
### Environment and Versions
<!--
What are relevant versions you are using?
Describe your environment, platforms, devices and Operating System.
Include all versions of Cordova tooling, Operating System, also Third-Party tools and programs.

For example:
Cordova: Cordova CLI, Cordova Platforms, Cordova Plugins
Other Frameworks: Ionic Framework and CLI version
Operating System, Android Studio, Xcode etc.
Cordova: Cordova CLI v0.0.0, Cordova Platform v0.0.0, Cordova Plugin v0.0.0
Other Tools/Frameworks: Ionic Framework 0.0.0 and Ionic CLI v0.0.0
Operating System, Android Studio, Xcode, etc.
-->



## Checklist
<!-- Please check the boxes by putting an x in the [ ] like so: [x] -->
<!-- Please check the boxes by putting an `x` in the `[ ]` like so: `[x]` -->

**Before submitting an issue, make sure to:**
- [ ] I searched for existing GitHub issues
- [ ] I updated all Cordova tooling to most recent version
- [ ] I updated all Cordova tooling to the most recent version
- [ ] I included all the necessary information above
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
name: 🚀 Feature Request
about: A suggestion for a new functionality

---

# Feature Request
Expand All @@ -13,17 +12,17 @@ about: A suggestion for a new functionality

## Feature Description
<!--
Describe your feature request in detail
Please provide any code examples or screenshots of what this feature would look like
Describe your feature request in detail.
Please provide code examples or screenshots on how this feature would look.
Are there any drawbacks? Will this break anything for existing users?
-->



## Alternatives or Workarounds
<!--
Describe alternatives or workarounds you are currently using
Are there ways to do this with existing functionality?
Describe possible alternatives or workarounds.
Is there a way to do this with existing functionality?
-->


9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
name: 💬 Support Question
about: If you have a question, please check out our Slack or StackOverflow!

---

<!------------^ Click "Preview" for a nicer view! -->
<!-- Click "Preview" for a nicer view! -->

Apache Cordova uses GitHub Issues as a feature request and bug tracker _only_.
For usage and support questions, please check out the resources below. Thanks!
Apache Cordova uses GitHub Issues _only_ for feature requests and tracking issues.
For usage and support questions, please check out the resources below. Thank you!

---

Expand All @@ -18,7 +17,7 @@ You can get answers to your usage and support questions about **Apache Cordova**

---

If you are using a tool that uses Cordova internally, like e.g. Ionic, check their support channels:
If you are using a tool that uses Cordova internally, for instance, Ionic, check their support channels:

* **Ionic Framework**
* [Ionic Community Forum](https://forum.ionicframework.com/)
Expand Down
31 changes: 18 additions & 13 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,40 @@
<!--
Please make sure the checklist boxes are all checked before submitting the PR. The checklist is intended as a quick reference, for complete details please see our Contributor Guidelines:
Before submitting the PR, please make sure that all checklist boxes are checked. The checklist is intended as a quick reference, for complete details, please see our Contributor Guidelines:

http://cordova.apache.org/contribute/contribute_guidelines.html

Thanks!
Thank you!
-->

### Platforms affected
### Platforms Affected
<!-- List which Electron platforms are affected by this change? -->



### Motivation and Context
<!-- Why is this change required? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here. -->
<!--
Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
-->



### Description
<!-- Describe your changes in detail -->
<!-- Describe your changes in detail. -->



### Testing
<!-- Please describe in detail how you tested your changes. -->
<!-- Describe in detail how you tested your changes. -->



### Checklist

- [ ] I've run the tests to see all new and existing tests pass
- [ ] I added automated test coverage as appropriate for this change
- [ ] Commit is prefixed with `(platform)` if this change only applies to one platform (e.g. `(android)`)
- [ ] If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct [keyword to close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
- [ ] I've updated the documentation if necessary
<!-- Please check the boxes by putting an `x` in the `[ ]` like so: `[x]` -->

**Before submitting Pull Request, make sure to:**
- [ ] Add automated tests as appropriate for this change (test code coverage should remain the same)
- [ ] Run the `npm test` to see that all tests pass
- [ ] If Pull Request contains a bug fix or a feature, describe at least one use case scenario and confirm it works as expected
- [ ] If Pull Request resolves an issue, link to the corresponding issue in the text above (use the correct [keyword to close issue](https://help.github.com/articles/closing-issues-using-keywords/))
- [ ] If Pull Request contains a feature, update the documentation