Each course that wants to use Classy must fork the root Classy project. The fork is used as a place to maintain stable code and custom development work for the course. Even if you do not plan to change the default Classy code, it is required that you create a fork of the repository because your fork will act as a stable code source during the semester, even while code is being developed upstream.
Any user can fork the UBCCPSC Classy respository, but it is strongly recommended that technical staff create the fork in an organization for an instructor. This will give technical staff access to your fork. Access to the fork allows technical staff to maintain Classy for your course by downstreaming changes to your fork. The instructor of the course should always be an owner in the organization. With owner permissions, the instructor can manage adding students, TAs, or instructors to the organization when necessary.
- Setup fork for instructor on Github.com
- Use format
ubccpsc999for organization name
- Use format
- Give instructor access to fork with owner permissions
- Add relevant technical staff to the fork with owner permissions
- Setup branch permissions so that the
masterbranch is protected.
Continuous Integration (CI) tests can be run on forks that have active development work to ensure major features are not broken or diverge during development work. CI tests are highly reccomended if the instructor is doing significant development work on Classy.
Continuous Integration tests will notify contributors when tests fail on the fork. This preventative tactic minimizes the risk that broken features do not make their way into a production Classy environment.
- If an instructor will be doing custom development work on AutoTest, check to see if integration tests are required for the type of work that the instructor is doing.
- To implement CI tests, follow the Continuous Integration Setup instructions.