Skip to content

Processes

cainsusk edited this page Nov 12, 2023 · 1 revision

Documentation Process

Here we outline the different processes involved in using github in the context of IA & COMPSA.

1. Maintain biweekly Internal Newsletter

  1. Collect info from Directors & Presidents about what is coming up / going on for each portfolio
  2. Write it all down nicely in a markdown file in this repo
  3. Send it in a Discord server announcement, starting the firday before the first

2. Maintain Monthly Student Newsletter

  1. Summarize the last 2 Internal Newsletters to include only things important to students, making it quick and easy to read
  2. Also summarize the most recent GA's minutes to give updates and bring awareness to the GA
  3. Write the final draft up in $EMAIL_LIST_SENDING_SOFTWARE and send to $COMPUTING_STUDENT_EMAIL_LIST, starting on the day of the first GA (afterwards, in order to allow the minutes to be added)

3. Hold Monthly GA & Maintain Minutes

  1. Have a General Assembly on the first possible Monday of the month in the school year (ideally every four weeks)
  2. Write down and save GA minutes on GitHub
  3. The minutes should always document any votes and their outcomes talked about during the GA, and should document all other important information

4. Update Constitution Based on GA

  1. Create GitHub issues for all changes to the constitution required thanks to the votes during the GA
  2. Make the changes to the constitution on a branch linked to the issue
  3. Once changes are complete, create a pull request and merge changes