Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add entity_creation.md doc #144

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Conversation

Jonathansumner
Copy link
Member

@Jonathansumner Jonathansumner commented Oct 14, 2022

Entity Development & Testing Documentation

Closing #26

  • Covers adding to the schema, creating a handler and updating project.yaml to introduce custom entities.
  • Discusses testing convention for these custom entities.

@Jonathansumner Jonathansumner marked this pull request as ready for review October 26, 2022 16:36
```
yarn codegen
```

Copy link

@bryanchriswhite bryanchriswhite Dec 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we'll need to add a section about how to add "order by" plugins (in the submodule 🙄) for new entities now that we're supporting custom ordering.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps there's some low-effort change we could make which would allow us to move the custom ordering plugin code out of the subql submodule and into this repo. I think that would improve maintainability.

- L16 - assert that the result is not null.
- L17 - assert the actual field value against the expected value.


Copy link

@bryanchriswhite bryanchriswhite Dec 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would make sense to add a section about migrations here. We can probably copy, move, and/or reference the DB Migrations section of the README for most of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants