Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.64 KB

Contributing to Topo

👋🏻 Welcome to Topo by CabinDAO! It's great you're here.

Onboarding

  1. Join Cabin by joining our Discord and following the path laid out in the #01-welcome-to-cabin channel.

  2. After you onboard onto Cabin, you can ask for access to our bounty board that shows tasks we need help with.

  3. You then need to onboard into the Product Guild by following the instructions in the Product Guild #start-here channel.

  4. Now you're ready to request bounties! Check out #110 Write SETUP.md for Topo as a possible task to take on.

How to Contribute

  1. You need to get approved for a component/bounty by requesting it on the bounty board. Request the bounty by asking in the comments of the bounty.
  2. Once approved, you can fork the repo and make a branch named after your feature for your changes. When you're done you can request to merge your branch into the main repo using a pull request.

Using Hygen

Hygen is a tool we use for scaffolding out components. If you're creating a new component, create the component like so:

npx hygen component new --name SomeComponent

Hygen generates the base files for a new component. The benefits of Hygen consistency from component to component and making refactoring easier later (can use codemod).