hasura / hasura/graphql-engine

Add a comment field to events

Open
#4,631 2 comments 0 reactions 1 assignee Claimed by @tirumaraiselvan View on GitHub
a/eventing a/eventing/data-triggers c/server k/enhancement
Dominant language
TypeScript
Stars
32.1k
Forks
3k
PR merge metrics
PR metrics pending

Description

While having good names on events and actions make understanding them easier, sometimes a new developer may be wondering how things fit together.

In the same way one would add a doc block on top of a function, it would be ideal to have documentation available for what events and actions do. This documentation, in the form of a description field can be displayed in the console for developers to consult and possibly export as more structured documentation.

With some guidance, I can implement this feature if you think it is a good idea

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.