Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 1.93 KB
Raw

Contributing to github-management-scripts

👏 First off, thank you for taking the time to contribute. 👏

  • Fork the repository
  • Create a new branch on your fork
  • Commit your changes
  • Create a pull request against the main branch

Project walkthrough

This project uses GitHub GraphQL API to produce two types of reports, a viewer report produced for the invoking user, and an org report produced multiple times per organization configured.
The reports are stored in S3 Buckets and compared to the previous reports, if diffs found, an email will be sent via SES to the configured email address noting the diffs.

  • src/main.js is the main entrypoint for the app, it instantiates the APIs, builds the various reports, and handles the diff checks, bucket uploads, and emails.
  • src/reports/org.js is the org report builder, aggregating the various org_x queries.
  • src/reports/viewer.js is the viewer report builder, aggregating the various viewer_x queries.
  • src/queries holds the various query functions, org_*.js and viewer_*.js represents the org and viewer reports respectively.
  • src/queries/fragments.js holds various fragments used through out the project.
  • src/common.js holds global constants.
  • src/utils.js holds utility functions.