securesauce / precaution-beta

Precaution provides a simple, automated code review for GitHub projects by running code linters with a security focus on pull requests.
Other
1 stars 0 forks source link

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

Open joshuagl opened 5 years ago

joshuagl commented 5 years ago

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