Skip to content

Commit db390b7

Browse files
committed
add example build of Scaffold-ETH 2 with Agent support for The Graph
1 parent 94a61ac commit db390b7

File tree

176 files changed

+14218
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

176 files changed

+14218
-0
lines changed
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Welcome to Scaffold-ETH 2 Contributing Guide
2+
3+
Thank you for investing your time in contributing to Scaffold-ETH 2!
4+
5+
This guide aims to provide an overview of the contribution workflow to help us make the contribution process effective for everyone involved.
6+
7+
## About the Project
8+
9+
Scaffold-ETH 2 is a minimal and forkable repo providing builders with a starter kit to build decentralized applications on Ethereum.
10+
11+
Read the [README](README.md) to get an overview of the project.
12+
13+
### Vision
14+
15+
The goal of Scaffold-ETH 2 is to provide the primary building blocks for a decentralized application.
16+
17+
The repo can be forked to include integrations and more features, but we want to keep the `main` branch simple and minimal.
18+
19+
### Project Status
20+
21+
The project is under active development.
22+
23+
You can view the open Issues, follow the development process, and contribute to the project.
24+
25+
### Rules
26+
27+
1. All code contributions require an Issue to be created and agreed upon by core contributors before submitting a Pull Request. This ensures proper discussion, alignment, and consensus on the proposed changes.
28+
2. Contributors must be humans, not bots.
29+
3. First-time contributions must not contain only spelling or grammatical fixes.
30+
31+
## Getting started
32+
33+
You can contribute to this repo in many ways:
34+
35+
- Solve open issues
36+
- Report bugs or feature requests
37+
- Improve the documentation
38+
39+
Contributions are made via Issues and Pull Requests (PRs). A few general guidelines for contributions:
40+
41+
- Search for existing Issues and PRs before creating your own.
42+
- Contributions should only fix/add the functionality in the issue OR address style issues, not both.
43+
- If you're running into an error, please give context. Explain what you're trying to do and how to reproduce the error.
44+
- Please use the same formatting in the code repository. You can configure your IDE to do it by using the prettier / linting config files included in each package.
45+
- If applicable, please edit the README.md file to reflect the changes.
46+
47+
### Issues
48+
49+
Issues should be used to report problems, request a new feature, or discuss potential changes before a PR is created.
50+
51+
#### Solve an issue
52+
53+
Scan through our [existing issues](https://github.com/scaffold-eth/scaffold-eth-2/issues) to find one that interests you.
54+
55+
If a contributor is working on the issue, they will be assigned to the individual. If you find an issue to work on, you are welcome to assign it to yourself and open a PR with a fix for it.
56+
57+
#### Create a new issue
58+
59+
If a related issue doesn't exist, you can open a new issue.
60+
61+
Some tips to follow when you are creating an issue:
62+
63+
- Provide as much context as possible. Over-communicate to give the most details to the reader.
64+
- Include the steps to reproduce the issue or the reason for adding the feature.
65+
- Screenshots, videos, etc., are highly appreciated.
66+
67+
### Pull Requests
68+
69+
#### Pull Request Process
70+
71+
We follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
72+
73+
1. Fork the repo
74+
2. Clone the project
75+
3. Create a new branch with a descriptive name
76+
4. Commit your changes to the new branch
77+
5. Push changes to your fork
78+
6. Open a PR in our repository and tag one of the maintainers to review your PR
79+
80+
Here are some tips for a high-quality pull request:
81+
82+
- Create a title for the PR that accurately defines the work done.
83+
- Structure the description neatly to make it easy to consume by the readers. For example, you can include bullet points and screenshots instead of having one large paragraph.
84+
- Add the link to the issue if applicable.
85+
- Have a good commit message that summarises the work done.
86+
87+
Once you submit your PR:
88+
89+
- We may ask questions, request additional information, or ask for changes to be made before a PR can be merged. Please note that these are to make the PR clear for everyone involved and aim to create a frictionless interaction process.
90+
- As you update your PR and apply changes, mark each conversation resolved.
91+
92+
Once the PR is approved, we'll "squash-and-merge" to keep the git commit history clean.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 BuidlGuidl
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)