CONTRIBUTING.md

Contributing Guide -- Epsilon Functions

At this time, StuySU IT is not accepting external contributions. The following documentation is meant for Directors.

Development Stack

Supabase Edge Functions are written in TypeScript for the Deno runtime.

Editing Process

1. Write the code needed to add or enhance functionality.
   • Note that if you are duplicating code, it may be helpful to write a function in the _shared/ directory.
2. Run deno fmt to ensure that your code is formatted consistently with existing code.
3. Verify via git diff that you have made the correct changes, and commit the changed files to a branch.
4. Test any changed routes using a locally hosted instance of Supabase.
5. Once all routes and edited functions have been tested, push the changes into the master branch. A GitHub webhook will automatically tell the deployment on base.stuysu.org to pull and deploy the updated functions.