diff options
author | Carl Lerche <me@carllerche.com> | 2018-08-24 13:03:34 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-08-24 13:03:34 -0700 |
commit | 7dc6404726633474f8c8a03502a6a06250c9c916 (patch) | |
tree | 5f426d730c25c50c5db69bd6586366aa1785e13b /.github | |
parent | 2e88e29fe923828ad1f6b5ea15beda0fcb219a01 (diff) |
draft initial CONTRIBUTING guide (#567)
This guide was adopted from the node.js project.
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE.md | 51 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 23 |
2 files changed, 74 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..26978063 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,51 @@ +<!-- +Thank you for reporting an issue. + +Please fill in as much of the template below as you're able. +--> + +## Version + +<!-- +List the versions of all `tokio` crates you are using. The easiest way to get +this information is using `cargo-tree`. + +`cargo install cargo-tree` +(see install here: https://github.com/sfackler/cargo-tree) + +Then: + +`cargo tree | grep tokio` +--> + +## Platform + +<!--- +Output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) +--> + +## Subcrates + +<!-- +If known, please specify the affected Tokio sub crates. Otherwise, delete this +section. +--> + +## Description + +<!-- + +Enter your issue details below this comment. + +One way to structure the description: + +<short summary of the bug> + +I tried this code: + +<code sample that causes the bug> + +I expected to see this happen: <explanation> + +Instead, this happened: <explanation> +--> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..bbff0233 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ +<!-- +Thank you for your Pull Request. Please provide a description above and review +the requirements below. + +Bug fixes and new features should include tests. + +Contributors guide: https://github.com/tokio-rs/tokio/blob/master/CONTRIBUTING.md +--> + +## Motivation + +<!-- +Explain the context and why you're making that change. What is the problem +you're trying to solve? In some cases there is not a problem and this can be +thought of as being the motivation for your change. +--> + +## Solution + +<!-- +Summarize the solution and provide any necessary context needed to understand +the code change. +--> |