diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..e46a48c8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,36 @@ +--- +title: 'Bug report' +labels: user report +--- + +### 🐛 Bug Report + + + +#### What version of Wrangler are you using (`wrangler -V`)? + +
+$ wrangler -V
+
+
+ +#### Does this issue reproduce with the latest release? + + + +#### What environment are you using? +* operating system: +* rustc version: +* node version: + +#### What did you do? + + + +#### What did you expect to see? + + + +#### What did you see instead? diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..fe5cdf79e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +title: 'Feature request' +labels: user report +--- + +### 💡 Feature request + + + +#### Overview and problem statement +Brief explanation of the requested feature, and a description of the problem it would solve. + +#### Basic example +Include a basic code example of this new feature if possible. Omit this section if not applicable. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..620bf3110 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,69 @@ +# Contributing + +Wrangler is an open source project because we believe that folks should have access, insight, +and the opportunity to contirbute to their developer tools. Wrangler is also a product +delivered by Cloudflare, so it's important to clarify how we think about issue triage and +contributions. + +## People + +Wrangler is maintained by @ashleygwilliams, and her team, [Workers Developer Experience]. + +[Workers Developer Experience]: https://github.com/orgs/cloudflare/teams/workers-devexp + +## Primary Issue Triage + +Within 3 days, any incoming issue should be triaged. Triage involves: + +- reading the issue and requesting any further information +- always thank the user for submitting + +### Labelling + +- label all issues coming from non-team members with User Report +- labelling the category of the issue: Feature, External Bug, Bug, Maintenance, Docs +- optionally labelling a secondary category: Webpack, Routes, Workers Runtime, Refactor +- labelling the status of the issue: Need More Info, Needs Repro, Needs Design, PR Welcome +- optionally labelling other calls to action: Help Wanted, Question + +### Assignment + +- if the issue will require a large amount of back and forth between the reporter and the team + assign a single team member to manage the conversation + +## Product Issue Triage + +Once a week, the team meets to do Product Triage. This is where we assign work and update +our plans for the milestones and releases. + +### Labelling + +- labelling the priority of the issue: Critical, Nice to Have, Low Priority +- labelling the status of the issue: Needs Design, PR Welcome + +### Assignment and Milestones + +- assign all issues for the next two releases a milestone +- assign all issues for the current milestone a person to take point + +### Pull Request Triage + +Within 3 days, all incoming Community PRs should be triaged. If a team member opens a PR it +should be triaged immediately upon open by the PR author. + +### Labelling + +- All work-in-progress PRs should be labelled Work In Progress and the title should be + annotated [WIP] for easy scanning. No WIP PRs will be reviewed until the annotations + are removed. +- All PRs that need to be reviewed should be labelled Needs Review until they have + received all required reviews. +- All PRs should be labelled with a changelog label: BREAKING, Feature, Bug, Maintenance, Docs + +### Merging + +- All PRs should be merged with a Merge Commit. We recommend that folks rebase into a small + number of task driven commits. This is enforced more heavily for team members than + community members. Be reasonable. +- All PRs should be labelled with the current milestone before merging. If a PR for an issue + labelled with a different milestone is to be merged, update the issue milestone as well. diff --git a/Cargo.lock b/Cargo.lock index 273d9601f..b99c2c648 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1580,6 +1580,11 @@ dependencies = [ "libc 0.2.58 (registry+https://github.com/rust-lang/crates.io-index)", ] +[[package]] +name = "text_io" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" + [[package]] name = "textwrap" version = "0.11.0" @@ -1948,6 +1953,7 @@ dependencies = [ "reqwest 0.9.18 (registry+https://github.com/rust-lang/crates.io-index)", "serde 1.0.92 (registry+https://github.com/rust-lang/crates.io-index)", "serde_json 1.0.39 (registry+https://github.com/rust-lang/crates.io-index)", + "text_io 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)", "toml 0.5.1 (registry+https://github.com/rust-lang/crates.io-index)", "uuid 0.7.4 (registry+https://github.com/rust-lang/crates.io-index)", "which 2.0.1 (registry+https://github.com/rust-lang/crates.io-index)", @@ -2171,6 +2177,7 @@ dependencies = [ "checksum termcolor 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)" = "96d6098003bde162e4277c70665bd87c326f5a0c3f3fbfb285787fa482d54e6e" "checksum termion 1.5.3 (registry+https://github.com/rust-lang/crates.io-index)" = "6a8fb22f7cde82c8220e5aeacb3258ed7ce996142c77cba193f203515e26c330" "checksum termios 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)" = "72b620c5ea021d75a735c943269bb07d30c9b77d6ac6b236bc8b5c496ef05625" +"checksum text_io 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)" = "9658b61ebd1d2a40c276ba2335890b9eb6550b67458a6fbce2022e58c3350a50" "checksum textwrap 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)" = "d326610f408c7a4eb6f51c37c330e496b08506c9457c9d34287ecc38809fb060" "checksum thread_local 0.3.6 (registry+https://github.com/rust-lang/crates.io-index)" = "c6b53e329000edc2b34dbe8545fd20e55a333362d0a321909685a19bd28c3f1b" "checksum time 0.1.42 (registry+https://github.com/rust-lang/crates.io-index)" = "db8dcfca086c1143c9270ac42a2bbd8a7ee477b78ac8e45b19abfb0cbede4b6f" diff --git a/Cargo.toml b/Cargo.toml index 9d0a730d5..c4195157b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -32,6 +32,7 @@ number_prefix = "0.3.0" flate2 = "1.0.7" base64 = "0.10.1" lazy_static = "1.3.0" +text_io = "0.1.7" exitfailure = "0.5.1" [dev-dependencies] diff --git a/README.md b/README.md index a9e76979a..9a2dc163b 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,9 @@ cargo install wrangler ## 🎙️ Commands - - ### 👯 `generate` + - ### 👯 `generate` Scaffold a project, including boilerplate for a Rust library and a Cloudflare Worker. - You can pass a name and template to this command optionally. + You can pass a name and template to this command optionally. ``` wrangler generate