Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update nomenclature inline with latest naming #317

Merged
merged 1 commit into from
Apr 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Welcome to Scaffold-ETH 2 Contributing Guide

Thank you for investing your time in contributing to Scaffold-Eth 2!
Thank you for investing your time in contributing to Scaffold-ETH 2!

This guide aims to provide an overview of the contribution workflow to help us make the contribution process effective for everyone involved.

## About the Project

Scaffold-Eth 2 is a minimal and forkable repo providing builders with a starter kit to build decentralized applications on Ethereum.
Scaffold-ETH 2 is a minimal and forkable repo providing builders with a starter kit to build decentralized applications on Ethereum.

Read the [README](README.md) to get an overview of the project.

Expand All @@ -25,6 +25,7 @@ You can view the open Issues, follow the development process and contribute to t
## Getting started

You can contribute to this repo in many ways:

- Solve open issues
- Report bugs or feature requests
- Improve the documentation
Expand All @@ -43,7 +44,7 @@ Issues should be used to report problems, request a new feature, or discuss pote

#### Solve an issue

Scan through our [existing issues](https://github.com/scaffold-eth/se-2/issues) to find one that interests you.
Scan through our [existing issues](https://github.com/scaffold-eth/scaffold-eth-2/issues) to find one that interests you.

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.

Expand All @@ -52,6 +53,7 @@ If a contributor is working on the issue, they will be assigned to the individua
If a related issue doesn't exist, you can open a new issue.

Some tips to follow when you are creating an issue:

- Provide as much context as possible. Over-communicate to give the most details to the reader.
- Include the steps to reproduce the issue or the reason for adding the feature.
- Screenshots, videos etc., are highly appreciated.
Expand All @@ -70,13 +72,15 @@ We follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
6. Open a PR in our repository and tag one of the maintainers to review your PR

Here are some tips for a high-quality pull request:

- Create a title for the PR that accurately defines the work done.
- 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.
- Add the link to the issue if applicable.
- Have a good commit message that summarises the work done.

Once you submit your PR:
- 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 aims to create a frictionless interaction process.

- 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 aims to create a frictionless interaction process.
- As you update your PR and apply changes, mark each conversation resolved.

Once the PR is approved, we'll "squash-and-merge" to keep the git commit history clean.
Once the PR is approved, we'll "squash-and-merge" to keep the git commit history clean.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
- [Disabling commit checks](#disabling-commit-checks)
- [Deploying to Vercel without any checks](#deploying-to-vercel-without-any-checks)
- [Disabling Github Workflow](#disabling-github-workflow)
- [Contributing to Scaffold-Eth 2](#contributing-to-scaffold-eth-2)
- [Contributing to Scaffold-ETH 2](#contributing-to-scaffold-eth-2)

## Requirements

Expand Down Expand Up @@ -78,7 +78,7 @@ Once you are ready to deploy your smart contracts, there are a few things you ne

By default, `yarn deploy` will deploy the contract to the local network. You can change the defaultNetwork in `packages/hardhat/hardhat.config.ts.` You could also simply run `yarn deploy --network target_network` to deploy to another network.

Check the `hardhat.config.ts` for the networks that are pre-configured. You can also add other network settings to the `hardhat.config.ts file`. Here are the [Alchemy docs](https://docs.alchemy.com/docs/how-to-add-alchemy-rpc-endpoints-to-metamask) for information on specific networks.
Check the `hardhat.config.ts` for the networks that are pre-configured. You can also add other network settings to the `hardhat.config.ts file`. Here are the [Alchemy docs](https://docs.alchemy.com/docs/how-to-add-alchemy-rpc-endpoints-to-metamask) for information on specific networks.

Example: To deploy the contract to the Sepolia network, run the command below:

Expand Down Expand Up @@ -262,8 +262,8 @@ We have github workflow setup checkout `.github/workflows/lint.yaml` which runs

To disable it, **delete `.github` directory**

## Contributing to Scaffold-Eth 2
## Contributing to Scaffold-ETH 2

We welcome contributions to Scaffold-Eth 2!
We welcome contributions to Scaffold-ETH 2!

Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/se-2/blob/master/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-Eth 2.
Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2.
2 changes: 1 addition & 1 deletion packages/hardhat/test/YouContract.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ describe("YourContract", function () {
});

it("Should allow setting a new message", async function () {
const newGreeting = "Learn scaffold-eth! :)";
const newGreeting = "Learn Scaffold-ETH 2! :)";

await yourContract.setGreeting(newGreeting);
expect(await yourContract.greeting()).to.equal(newGreeting);
Expand Down
4 changes: 2 additions & 2 deletions packages/nextjs/pages/example-ui.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ const ExampleUI: NextPage = () => {
return (
<>
<Head>
<title>Scaffold-eth Example Ui</title>
<meta name="description" content="Created with 🏗 scaffold-eth" />
<title>Scaffold-ETH 2 Example Ui</title>
<meta name="description" content="Created with 🏗 scaffold-eth-2" />
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we mention "Scaffold-ETH 2" here ?

{/* We are importing the font this way to lighten the size of SE2. */}
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link href="https://fonts.googleapis.com/css2?family=Bai+Jamjuree&display=swap" rel="stylesheet" />
Expand Down
6 changes: 3 additions & 3 deletions packages/nextjs/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ const Home: NextPage = () => {
return (
<>
<Head>
<title>Scaffold-eth App</title>
<meta name="description" content="Created with 🏗 scaffold-eth" />
<title>Scaffold-ETH 2 App</title>
<meta name="description" content="Created with 🏗 scaffold-eth-2" />
</Head>

<div className="flex items-center flex-col flex-grow pt-10">
<div className="px-5">
<h1 className="text-center mb-8">
<span className="block text-2xl mb-2">Welcome to</span>
<span className="block text-4xl font-bold">scaffold-eth 2</span>
<span className="block text-4xl font-bold">Scaffold-ETH 2</span>
</h1>
<p className="text-center text-lg">
Get started by editing{" "}
Expand Down
2 changes: 1 addition & 1 deletion packages/nextjs/services/web3/wagmiConnectors.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ const wallets = [
walletConnectWallet({ chains: appChains.chains }),
ledgerWallet({ chains: appChains.chains }),
braveWallet({ chains: appChains.chains }),
coinbaseWallet({ appName: "scaffold-eth", chains: appChains.chains }),
coinbaseWallet({ appName: "scaffold-eth-2", chains: appChains.chains }),
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hope this is fine

rainbowWallet({ chains: appChains.chains }),
];

Expand Down