Skip to content

Commit

Permalink
docs: add readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
prestwich committed Aug 28, 2023
1 parent 611a057 commit a9ca8ae
Show file tree
Hide file tree
Showing 23 changed files with 968 additions and 172 deletions.
6 changes: 6 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* @danipopes @gakonst @prestwich

crates/json-rpc @prestwich
crates/transports @prestwich
crates/networks @prestwich
crates/providers @prestwich
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-FORM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Bug report
description: File a bug report
labels: ["bug"]
title: "[Bug] "
body:
- type: markdown
attributes:
value: |
Please ensure that the bug has not already been filed in the issue tracker.
Thanks for taking the time to report this bug!
- type: dropdown
attributes:
label: Component
description: What component is the bug in?
multiple: true
options:
- json-rpc
- transports
- networks
- providers
validations:
required: true
- type: input
attributes:
label: What version of Alloy are you on?
placeholder: "Run `carge tree | grep alloy` and paste the output here"
- type: dropdown
attributes:
label: Operating System
description: What operating system are you on?
options:
- Windows
- macOS (Intel)
- macOS (Apple Silicon)
- Linux
- Other (please specify)
- type: textarea
attributes:
label: Describe the bug
description: Please include code snippets as well if relevant.
validations:
required: true
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-FORM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature request
description: Suggest a feature
labels: ["enhancement"]
title: "[Feature] "
body:
- type: markdown
attributes:
value: |
Please ensure that the feature has not already been requested in the issue tracker.
- type: dropdown
attributes:
label: Component
description: What component is the feature for?
multiple: true
options:
- json-rpc
- transports
- networks
- providers
validations:
required: true
- type: textarea
attributes:
label: Describe the feature you would like
description: Please also describe your goals for the feature. What problems it solves, how it would be used, etc.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context to the feature (like screenshots, resources)
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Support
url: https://t.me/ethers_rs
about: This issue tracker is only for bugs and feature requests. Support is available on Telegram!
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 @@
<!--
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/alloy-rs/core/blob/main/CONTRIBUTING.md
The contributors guide includes instructions for running rustfmt and building the
documentation.
-->

<!-- ** Please select "Allow edits from maintainers" in the PR Options ** -->

## 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.
-->

## PR Checklist

- [ ] Added Tests
- [ ] Added Documentation
- [ ] Breaking changes
Loading

0 comments on commit a9ca8ae

Please sign in to comment.