Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 1.76 KB
Raw

Contributing

Contributions are welcome!

  1. Check the ISSUES. Read every issue to understand what's needed and whether it's something you can help with.

  2. Ask other contributors to see if no one has taken the issue yet. If you're interested in tackling such a feature and it's still available, we will assign you to the task.

  3. Clone the repo and create your own branch using git checkout -b your_branch_name. Remember to use a branch name that describes WHAT you're doing/fixing.

  4. Setup your local development environment. Instructions

  5. Once your work is done with the local copy of the repo, don't hesitate to open a pull request. We'll gladly revise and push as deemed fit.

  6. Feel free to add new issues as you read the code and find inconsistencies and/or possible features that may add up to the website. Follow the labeling standards to make it easier to understand what you're proposing.

  7. Document changes and/or issues clearly. Make it easy for everyone involved to understand your ideas/changes.

Local development

To setup your local dev environment:

# Clone the repo

cd create-web3

# yarn install also runs `preconstruct dev`, which dynamically links all
# packages in the monorepo together.
yarn install

# all development can be done from the root folder
# to start a local hardhat chain, in one terminal
yarn chain

# in another terminal, deploy the contract locally with
yarn deploy
# then you can start developing with
yarn dev

Creating a pull request

In order to create a pull request for create-dao, follow the GitHub instructions for Creating a pull request from a fork. Please link your pull request to an existing issue.