-
Notifications
You must be signed in to change notification settings - Fork 3
Description
Problem
We need to make it more intuitive and simple for external contributors to figure out what's going on in the repo. Currently, there's too much of a learning curve.
Goals
Refactor how the data files are organized in ENSAwards to make it more welcoming for external contributors.
Review each of the following and ensure it is optimized:
- Terminology
- Data model relationships
- Comments in code
- File names / how code is distributed across directories / files.
Initial Ideas
Loosely copied from this Slack thread. Good as a starting point, but we should adapt as we change things.
- Instead of putting all apps into a single file named
apps.ts, what if we had a directory structure such asdata/apps/{app-name}.tswhere each app had its own distinct file. And then a file such asdata/apps/index.tsthat imports all the app definitions into an overall array ofAPPS. - Alternatively directory structure such as
/data/apps/{app-name}/so that each app gets its own full directory. Then the definition for the app itself can go into anindex.tsinside each directory. Likewise, each protocol could go into/data/protocols/{protocol-name}/. With such a directory structure, you could do things like

Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
ensawardsENSAwards relatedENSAwards related
Type
Projects
Status
In Progress