Create Roadmap.md #360
+156
−0
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| ## Short-term | ||
|
|
||
| 🚧 Review new contributions (high priority) | ||
|
|
||
| - There are usually 10-15 open PRs going stale which is inefficient because they require plenty of work to update (when there's conflicts) and sometimes they get duplicated like [this](https://github.com/aragon/aragon-cli/pull/254) and [this](https://github.com/aragon/aragon-cli/pull/272) | ||
|
|
||
| 🚧 [Implement a mono repo structure with `lerna`](https://github.com/aragon/aragon-cli/pull/325) | ||
|
|
||
| 🚧 Finish the `aragon start` command [here](https://github.com/aragon/aragon-cli/pull/255/files) which is intended to be more development friendly that `aragon run`, i.e. [doesn't create a new dao every time](https://github.com/aragon/aragon-cli/issues/311), uses http rather than ipfs (to have hot/live reload for the frontends, and maybe something similar for the contracts, a watch → compile loop) | ||
|
|
||
| 👾 [E2E tests with sharness](https://github.com/aragon/aragon-cli/issues/358) | ||
|
|
||
| 👾 Bugfixes, see all [here](https://github.com/aragon/aragon-cli/labels/bug) | ||
|
|
||
| - [gasLimit](https://github.com/aragon/aragon-cli/issues/346) issue | ||
| - [gas issue on dao acl grant](https://github.com/aragon/aragon-cli/issues/350) | ||
| - [dao new fails with ganache 2.3](https://github.com/aragon/aragon-cli/issues/321) (low priority because pinning works alright at the moment) | ||
|
|
||
| Note: We should write tests as we fix these to ensure no regressions! | ||
|
|
||
| 👾 Small features (low hanging fruit) | ||
|
|
||
| - remove [hard-coded gas price](https://github.com/aragon/aragon-cli/issues/353) (would be nice to let the user decide how much) | ||
|
|
||
| 👾 [Claiming an aragonid](https://github.com/aragon/aragon-cli/issues/347) | ||
|
|
||
| 👾 Document new features (dao token commands) | ||
|
|
||
| 👾 Restructure documentation on hack.aragon to include: | ||
|
|
||
| - Quick start / Overview / Introduction | ||
| - Guides around specific subjects (e.g.: Publish to different environments, Using a different Ethereum account, Propagating content, etc), similar to [this](https://github.com/aragon/aragon-react-boilerplate#publish). Maybe also link more in-depth guides such as [this](https://forum.aragon.org/t/guide-custom-aragon-organization-deployment-using-the-cli/507) | ||
| - FAQ section. We have [this](https://hack.aragon.org/docs/cli-usage.html#troubleshooting-faq) currently, but it should be it's own section and much more elaborate (If there is a recurring question on #dev-help we will add it there) | ||
|
|
||
| ## Long-term | ||
|
|
||
| - Types (use Flow or Typescript) because it will allow us to catch more "errors" at compile time, having commands silently fail without noticing (like [this](https://github.com/aragon/aragon-cli/pull/334#discussion_r248659171)) less often. Using Typescript is also great for intellisense support (having auto-completion from IDEs) and refactoring | ||
| - Improve smart contract tooling using new Ethereum dev tools from 0x: | ||
| - `[sol-trace](https://sol-trace.com)`: Human-readable stack traces | ||
| - `[sol-coverage](https://sol-coverage.com)`*:* Solidity code coverage | ||
| - `[sol-profiler](https://sol-profiler.com)`: Gas profiling for Solidity | ||
| - `[sol-compiler](https://sol-compiler.com)`: Solidity compilation | ||
|
|
||
| We plan to prioritize `sol-trace` and to look into the benefits that the others tools could have on the developer experience and decide whether to work on that *short-term*. | ||
|
There was a problem hiding this comment. Brett: I'd wait until 0xProject/0x-monorepo#1520 is fixed, otherwise asking devs to spin up a geth node to do this is a bit cumbersome (i.e. I wouldn't bother until I had a failing test that was difficult debug by itself) |
||
|
|
||
| - Identify contracts like the `MiniMeTokenFactory` which do not need to be deployed every time, but rather reused, and publish them to `aragonpm.eth` (just like the `dao-kits`) | ||
|
There was a problem hiding this comment. Brett: Ohh good idea, do we publish this every time on aragon run? We should just hardcode an address in aragen like we do with the root ENS. |
||
|
|
||
| - Wizard onboarding 🧙♂️ | ||
| - The goal of this tool will be to help new users create a custom DAO | ||
| - "Import" the onboarding of the multisig and democracy kits from the ui client | ||
| - Improve UX for installing "core" apps (e.g.: TokenManager, Voting, etc.), because currently is a bit tricky as you have to check what arguments the `initialize` function takes from the app's contract and pass them with `--app-init-args`, e.g.: `dao install [dao-address] voting --app-init-args 0x00000001 600000000000000000 250000000000000000 604800`. We should do this, instead of the users, so they can see what are the needed parameters with `--help` or `--interactive`. For example `dao install voting --help` could return `dao install voting [dao-address] [token-address] [support-required] [quorum] [vote-time]` | ||
|
There was a problem hiding this comment. Brett: We should be able to do get the initialize function's params from the artifact.json if it's published onto an aragonPM instance |
||
| - Commands can become interactive (with prompts) using `[yargs-interactive](https://www.npmjs.com/package/yargs-interactive)` | ||
|
|
||
| Example: To create a new MiniMe token, you would use the `dao token new` command, which takes the following arguments `<token-name> <symbol> [decimal-units] [transfer-enabled]`, e.g.: `dao token new "Aragon Network Token" "ANT" 18 true`. Using | ||
|
|
||
| `dao token new --interactive` though, would output this: | ||
|
|
||
|  | ||
|
|
||
| ## Ongoing | ||
|
|
||
| - Active on the different dev-related aragon.chat channels. We aim to respond within one day and to allocate ~1 hour each day to debug issues like [this](https://github.com/aragon/aragon-react-kit-boilerplate/issues/19), help people deploy to testnets, etc. | ||
| - Aragen maintenance | ||
| - Prioritize this roadmap | ||
|
There was a problem hiding this comment. Brett: My thinking on priorities:
May also be good to speak with Autark to see if they have any lingering pains with the CLI (there's one issue with stopping IPFS that's solved by sleeping, but would be good if we didn't end the process until we knew that IPFS was stopped). I don't foresee too many items that A1 will need in the next two to three months which Luke hasn't already brought up. There was a problem hiding this comment. Daniel: Thanks a lot for the feedback!! There was a problem hiding this comment. @0x6431346e There's no issue for it yet, but can be easily tested by going between this commit and the one before it: AutarkLabs/open-enterprise@e3178eb. As for open PRs, hopefully those can go with 1 and 2 :). |
||
| - with issues that are blocking users | ||
| - with features needed by flock/nest teams | ||
| - together with the community, by having this document public and by having a "sprint/milestone" every 2 weeks which people can "influence" during the all devs call or directly in GitHub ([aragon-cli#milestones](https://github.com/aragon/aragon-cli/milestones?direction=asc&sort=due_date)) | ||
|
|
||
| Note: These documents should be moved to GitHub | ||
|
|
||
| [aragonCLI specification](https://www.notion.so/0eda0bfd145b4d15b6aaa874aadf6d97) | ||
|
|
||
| [JavaScript project practices](https://www.notion.so/ae5c9f94e9e3432fb31ad9d997962f56) | ||
|
|
||
| --- | ||
|
|
||
| ## Legend | ||
|
|
||
| 🚧 In progress | ||
|
|
||
| 👾 New issues | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Brett: I wouldn't say these are necessarily within the scope of the CLI, but we can explore if replacing truffle makes sense in the CLI (probably doesn't, but we can upgrade to v5) and solidity-coverage in the boilerplates (really hoping this is possible).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I Been researching about this and the tools are framework agnostic so they can be configure with truffle if we want to keep using it. Here is a basic example: https://github.com/0xProject/dev-tools-truffle-example