Skip to content

Reorganize repositiory's data files #116

@Y3drk

Description

@Y3drk

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 as data/apps/{app-name}.ts where each app had its own distinct file. And then a file such as data/apps/index.ts that imports all the app definitions into an overall array of APPS.
  • 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 an index.ts inside each directory. Likewise, each protocol could go into /data/protocols/{protocol-name}/. With such a directory structure, you could do things like
Image

Metadata

Metadata

Assignees

Labels

Type

Projects

Status

In Progress

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions