Thank you for considering contributing to the DAOHaus protocol. We welcome any contributions that can help improve the project, including bug reports, feature requests, and code changes.
Contributions are made to the HausDAO/monorepo (opens in a new tab) via Issues and Pull Requests (PRs).
- Baal Contract Issues (opens in a new tab)
- Baal Token Issues (opens in a new tab)
- Shamans Issues (opens in a new tab)
Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
If you find an issue you want to work on follow the Pull Request instructions!
In general, PRs should:
- Address a single concern in the least number of changed lines as possible.
- Include documentation in the repo or on our docs site (opens in a new tab) if applicable.
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
In general, we follow the Fork and Pull Request Workflow (opens in a new tab)
- Fork the repository to your own Github account
- Clone the project to your machine
- Create a branch locally with a succinct but descriptive name
- Commit changes to the branch
- Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
Our monorepos use Nx (opens in a new tab) as a build system and for scaffolding. If this your first time using Nx, you'll have to install it globally on your system:
npm install -g nx
Here is a basic guide. Each package README (and
project.json) will have more details about commands within each package.
`git clone email@example.com:HausDAO/daohaus-monorepo.git` or `firstname.lastname@example.org:HausDAO/daohaus-monorepo.git` # clone the entire monorepo at the top level on the develop branch `nvm use` # switch to node 16.16.0 `yarn global add nx` # download nx globally for running nx commands `yarn` # run yarn to install all of the packages and dependencies
cp .env.sample .env
Rivet is the default RPC - Get a free Rivet key here (opens in a new tab).
You can also use Alchemy API keys for Optimism, Arbitrum or Polygon.
NX_OPTIMISM_ALCHEMY_KEY NX_ARBITRUM_ALCHEMY_KEY NX_POLYGONPOS_ALCHEMY_KEY
Proposal details uses Etherscan explorer APIs to fetch ABIs. Add a key for any chain you are supporting. Get an Etherscan API key here (opens in a new tab).
NX_ETHERSCAN_KEY NX_ARBISCAN_KEY NX_GNOSISSCAN_KEY NX_POLYGONSCAN_KEY NX_OPTIMISMSCAN_KEY
If developing for Mainnet or Gnosis Chain you can get an API key here (opens in a new tab). Ignore this one if not worried about Mainnet or Gnosis Chain yet.
Once cloned and everything is installed, you'll be able to run each package!
Package-level commands are run with
nx run instead of
yarn -- this may be new if you're used to working in a different monorepo structure. Each package has similar command structure, but some packages have additional commands.
The package-level commands can be found in each packages
# run a specific package locally (usually on localhost:3000) # such as the component library or frontend applications nx run app-name:serve # example to run the Admin app: nx run admin:serve # lint a specific package nx run app-name:lint # example to lint the Hub app: nx run hub-app:lint # build a specific package: nx run app-name:build # example to build the Summon app: nx run summon:build