Skip to content

Commit

Permalink
docs(todo): add TODO list and the development guide of new proposal type
Browse files Browse the repository at this point in the history
  • Loading branch information
Jameshsiao committed Jan 22, 2024
1 parent 0860e13 commit 38c801f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,21 @@ DAC (Decentralized Autonomous Consortium) Voting System
- `pnpm i` or use `yarn`
- Start the voting app
- `pnpm start` or `yarn start`

## TODO

### Before deployment

- **Theme**: `light` mode has not been fully tested
- **Dockerfile**: need to be created
- **camino-suite**: merge or modify the PR [#185](https://github.com/chain4travel/camino-suite/pull/185) to add DAC app
- **camino-suite-voting (this repo)**: make sure the included submodule `caminojs` referencing to the `addDACTx` branch of `caminojs`

## For the future development of new proposal type

- Implement the new proposal type in `caminojs`([addDACTx](https://github.com/chain4travel/caminojs/tree/addDACTx) branch), can reference to the
- `src/apis/platformvm/addproposaltx/addmemberproposal.ts` to extends the abstract class, `EssentialProposal`, and implement the necessary methods
- `src/apis/platformvm/constants.ts` to add the ID of the new proposal type
- Most of UI components have a draft according to the previous design in Figma, like General Proposal and Fee Distribution, can check under the folders, `pages/proposal/active`, `pages/proposal/completed`, and `pages/proposal/create`
- Add or modify the configuration to enable the proposal type in `routes/loaders.tsx` according to the value of `ProposalTypes` enum
- Update the `useAddProposal` hook in the `src/hooks/useProposals.ts` to add the new proposal type ID (sync with backend guys) with the extra parameters according to the caminojs API

0 comments on commit 38c801f

Please sign in to comment.