From 3dcec4dd4a1ca0db29f4b73b00524847da049f4c Mon Sep 17 00:00:00 2001 From: Daniel Imhoff Date: Thu, 4 Jun 2020 11:31:13 -0700 Subject: [PATCH 1/7] remove template that wasn't filled in --- .github/ISSUE_TEMPLATE/custom.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/custom.md diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 48d5f81fa4..0000000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: '' - ---- - - From c1c8126d1dbd433cc64626488974698856b9ef69 Mon Sep 17 00:00:00 2001 From: Daniel Imhoff Date: Thu, 4 Jun 2020 12:03:25 -0700 Subject: [PATCH 2/7] more concise instructions, less extreme titles --- .github/ISSUE_TEMPLATE/bug-report.md | 65 ++++++++++++++--------- .github/ISSUE_TEMPLATE/feature-request.md | 41 ++++++++------ 2 files changed, 67 insertions(+), 39 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index c4c33ba9ad..e0dfb1b21e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,52 +1,65 @@ --- -name: Bug Report -about: Template to report bugs +name: 🐛 Bug Report +about: Report something not working title: 'bug: ' labels: '' assignees: '' --- -# Bug Report +## Bug Report -## Capacitor Version - - -`npx cap doctor` output: +### Capacitor Version + +``` +PASTE OUTPUT HERE +``` -## Affected Platform(s) - +### Platform(s) + - [ ] Android - [ ] iOS - [ ] Electron - [ ] Web -## Current Behavior - - +### Current Behavior + -## Expected Behavior - -## Sample Code or Sample Application Repo - -NOTE: Issues with sample projects are prioritized higher than ones without because they are easier to reproduce and fix. -If you are able to illustrate the bug or feature request with an example, please provide sample code snippets or a sample application via a public GitHub or Bitbucket repo. +### Example Code or Repo + -## Reproduction Steps - -## Other Technical Details +### Reproduction Steps + - + + +### Other Technical Details + `npm --version` output: @@ -54,5 +67,9 @@ If you are able to illustrate the bug or feature request with an example, please `pod --version` output (iOS issues only): -## Other Information - \ No newline at end of file +### Other Information + + + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 938e0438a1..608ce951d1 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,33 +1,44 @@ --- -name: Feature Request -about: Request a feature addition or change to Capacitor. +name: 🙋 Feature Request +about: Request a feature or change title: 'feat: ' labels: '' assignees: '' --- -# Feature Request +## Feature Request -## Describe the Feature Request - +### Description + -## Platform Support Requested - + + +### Platform(s) + - [ ] Android - [ ] iOS - [ ] Electron - [ ] Web -## Describe Preferred Solution - +### Preferred Solution + + + + +### Alternatives + + + -## Describe Alternatives - +### Additional Context + -## Related Code - -## Additional Context - From b29de4ad64367cf8979c94befd5a80998508ed09 Mon Sep 17 00:00:00 2001 From: Daniel Imhoff Date: Thu, 4 Jun 2020 12:05:25 -0700 Subject: [PATCH 3/7] word --- .github/ISSUE_TEMPLATE/feature-request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 608ce951d1..c6801f2818 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -32,7 +32,7 @@ Check the box(es) for platforms for which this feature should be added. ### Alternatives - + From 18a207cc6b5afed87adb0ac0339e252a96a909cd Mon Sep 17 00:00:00 2001 From: Daniel Imhoff Date: Thu, 4 Jun 2020 12:08:58 -0700 Subject: [PATCH 4/7] more words --- .github/ISSUE_TEMPLATE/bug-report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index e0dfb1b21e..53e9f96720 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -67,7 +67,7 @@ Please provide the following information with your request and any other relevan `pod --version` output (iOS issues only): -### Other Information +### Additional Context From 182c1bfd5e9f4ca7d76a2ac5f844f47cc43e047b Mon Sep 17 00:00:00 2001 From: Daniel Imhoff Date: Thu, 4 Jun 2020 14:44:23 -0700 Subject: [PATCH 5/7] just ask people to list the platforms --- .github/ISSUE_TEMPLATE/bug-report.md | 7 ++----- .github/ISSUE_TEMPLATE/feature-request.md | 7 ++----- 2 files changed, 4 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 53e9f96720..fc44bad595 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -20,13 +20,10 @@ PASTE OUTPUT HERE ### Platform(s) -- [ ] Android -- [ ] iOS -- [ ] Electron -- [ ] Web + ### Current Behavior -- [ ] Android -- [ ] iOS -- [ ] Electron -- [ ] Web + ### Preferred Solution From a1e8a3afca4e9f469e743f622489b7327b460413 Mon Sep 17 00:00:00 2001 From: Daniel Imhoff Date: Mon, 8 Jun 2020 12:46:52 -0700 Subject: [PATCH 6/7] code repro steps --- .github/ISSUE_TEMPLATE/bug-report.md | 5 ++- .github/CONTRIBUTING.md => CONTRIBUTING.md | 44 +++++++++++----------- README.md | 2 +- 3 files changed, 27 insertions(+), 24 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (69%) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index fc44bad595..5a0ce28311 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -46,9 +46,10 @@ If you are able to illustrate the bug with an example, please provide sample cod -### Reproduction Steps +### Code Reproduction diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 69% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md index 41f0e131bb..23503f8023 100644 --- a/.github/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,11 +8,27 @@ Before working on Capacitor, it's important to understand the philosophy behind Please read [@maxlynch](http://twitter.com/maxlynch)'s essay [How Capacitor Works](https://tinyletter.com/ionic-max/letters/how-capacitor-works) for a deep dive into the project and its goals. -## Consult with the team +## Creating a Code Reproduction + +To isolate the cause of the problem, we ask you to provide a minimal sample application that demonstrates the issue. Without a reliable code reproduction, it is unlikely we will be able to resolve the issue, leading to it being closed. + +To create a code reproduction: + +* Create a new application using `npx @capacitor/cli create` (or `ionic start --capacitor`). +* Add the minimum amount of code necessary to recreate the issue you're experiencing. +* Push the code reproduction to a public GitHub repository and include a link when you create a bug report. +* Be sure to include steps to reproduce the issue. + +## Developing Capacitor + +1. Check out this repository. +2. Read and follow [`example/README.md`](../example/README.md) + +### Consult with the team For any large changes, make sure you've consulted with the team first. One way to do this would be to create a draft PR for discussion, or bringing up the discussion in the Capacitor slack. -## About Third Party Libraries +### About Third Party Libraries To achieve Capacitor's goal of being stable and easy to upgrade, we would like to avoid unnecessary third party libraries as much as possible. Before embarking on Capacitor contributions, make sure you aren't planning on introducing third party libraries without consulting with the team first. @@ -20,7 +36,7 @@ On native, that means avoid adding any new Cocoapod or Gradle dependencies witho On web, this means do not add any third party libraries such as Firebase or Lodash. Strive for implementations that use pure Web APIs even if it means more work. -## Directory Structure +### Directory Structure The `ionic-team/capacitor` repo is a monorepo containing all of the standard Capacitor components. The current directory structure looks like this: @@ -34,29 +50,15 @@ The `ionic-team/capacitor` repo is a monorepo containing all of the standard Cap * `example`: Example project for development * `e2e`: An end-to-end testing app * `plugin-template`: The default plugin template when creating a new plugin -* `scripts`: deploy and task scripts +* `scripts`: publish and task scripts * `site`: Website and documentation -## Developing Capacitor - -1. Check out this repository. -2. Read and follow [`example/README.md`](../example/README.md) - -## Deploying Capacitor (requires commit privileges) +## Publishing Capacitor -The `publish` npm task runs lerna to update and publish JS dependencies, and then uses that version number to deploy the Android and iOS runtimes. +Capacitor packages are published together with a fixed version using [Lerna](https://github.com/lerna/lerna). -Additionally, it updates the master branch of the [capacitor-starter](https://github.com/ionic-team/capacitor-starter) mirror, which contains an exported starter project for easy project creation, based on the code in the `starter` folder in this monorepo. +To publish Capacitor, run the following: -Before deploying, you must set the following environment variables: - - - `BINTRAY_USER`: your username from [bintray.com](http://bintray.com) - - `BINTRAY_KEY`: your API key from Bintray, found in the "Edit Profile" section of the site. - -Finally, to deploy Capacitor, in the root of the project run - ```bash npm run publish ``` - -Note: if you don't have any JS updates that cause lerna to increment the version, just increment it yourself in `lerna.json` and you're golden. diff --git a/README.md b/README.md index 0274659e74..6825ea9d51 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,6 @@ No, you do not need to use Ionic Framework with Capacitor. Without the Ionic Fra ## Contributing -See [`CONTRIBUTING.md`](.github/CONTRIBUTING.md) 💖 +See [`CONTRIBUTING.md`](CONTRIBUTING.md) 💖 To help with the Capacitor website or documentation, [see here](site/CONTRIBUTING.md). From 4fbf2655ad6795e41909bba452f2fe87abe6c761 Mon Sep 17 00:00:00 2001 From: Daniel Imhoff Date: Tue, 9 Jun 2020 12:58:19 -0700 Subject: [PATCH 7/7] add link to discussions --- .github/ISSUE_TEMPLATE/config.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..68882bce49 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Open a discussion + url: https://github.com/ionic-team/capacitor/discussions + about: Ask questions and discuss with other community members