backend

module
v0.2.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 3, 2024 License: GPL-3.0

README

programme.lv is a programming learning platform for scholars, students and others.

Test Action Status Badge Deploy Action Status Badge Go Report Card License

Overview

This repository contains source code for the backend of the programme.lv system. The backend is a GraphQL server that interacts with the PostgreSQL database and the RabbitMQ submission queue.

Git workflow & CI/CD

The two core branches of this repo are: dev & main:

  • dev is the branch that contains the latest development version of the code. Unit & integration tests are not automatically run against this branch. You can push to this branch directly, but it is recommended to create a feature branch and then create a pull request to dev.

  • main is a staging branch, where the code is tested before being deployed to production. After each push on main, unit and integration tests are run. Integration tests are run against the newest version of the database. If a commit is tagged it is then deployed to production.

For more CI/CD information look at actions defined in ./.github/workflows/.

TODO: trigger the testing workflow also on database changes.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've added code that need documentation, update the documentation.
  4. Write a good commit message.
  5. Issue that pull request!

Join our community on Discord!

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL