Skip to content

Usage of this Github page

Nima Dekhli edited this page Feb 11, 2024 · 6 revisions

Language

English is the only allowed language on this Github project. This applies to

  • Issues (title, description, comments)
  • Pull requests
  • Branches, tags, releases
  • Wiki
  • Code (variables, classes, methods, comments, ...)
  • Filenames

Workflow

For every task you work on, an issue and a branch must be created. Don't forget to add the issue to the project. Once the work is complete, create a pull request and ideally ask for a review. Once everything seems fine, the work can be merged on the main branch. Please only use "Squash" method (other methods should be disabled).

Linear history is required before merging on main. Rebase your work on main branch frequently to avoid conflicts.

If possible, commits should be signed using a valid GPG key.

Clone this wiki locally