Skip to content
This repository has been archived by the owner on Jan 10, 2024. It is now read-only.

Document the GitHub events we subscribe to and how they are used #211

Open
joshuagl opened this issue Apr 30, 2019 · 0 comments
Open

Document the GitHub events we subscribe to and how they are used #211

joshuagl opened this issue Apr 30, 2019 · 0 comments
Labels
enhancement New feature or request task-size-small

Comments

@joshuagl
Copy link
Contributor

Describe the solution you'd like
We subscribe to various GitHub events on the installed repositories in order to know when we should be performing an activity.

Whilst it is easy enough to determine which events and actions trigger processing within Precaution by reading the code it's not always obvious why those events and actions are important and how the flow of events/actions directs Precaution's processing.

We should document the event processing flow within Precaution, events we subscribe to and actions we handle within those events, so that new developers can understand the flow and existing developers have a reference when working on Precaution.

Additional context

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request task-size-small
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants