Cosmobot

Requirements

• Git LFS
• Unity 6000.0.60f1 LTS

Project File structure

• Animations
• Audio
• Scenes
• Materials
• Models
• Scripts
  • Main systems per dir
• Shaders
• Prefabs
• Textures
  • dir per prefab "group"

Contributing

Branching

• The main branch is the primary development branch.
• All development work should be done in feature branches.
• Branch names should be descriptive and follow the pattern: feat/issue-number/your-feature or fix/issue-number/your-bug-fix, e.g. feat/1/player-movement.
• Branches should be merged into main using a pull request (PR).
• Branches should be deleted after merging.

Pull Requests

• Before creating a pull request (PR), ensure that your branch is up to date with the latest changes from the main branch.
• Each PR should address a single issue.
• PR titles and commit messages should follow the Conventional Commits include issue number and be concise and descriptive, summarizing the changes made, e.g. feat(#1): add player movement.
• Reference the related issue in your PR description using the syntax Fixes #issueNumber or Closes #issueNumber to automatically close the linked issue when the PR is merged.
• The PR should be reviewed by at least one other team member before merging.
• The PR should be merged by the person who created it.
• Add appropriate "type:" labels to the PR to indicate the type of change made, e.g. type: bug, type: feature, etc.

Formatting

Use standard dotnet-format. There are avaliable script:

• Run in project root directory:
  • Format check: ./format-check.sh.bat
  • Auto formatting (whitespace only): ./format-code.sh.bat (if possible)

Works both on Linux and Windows (but have .bat extension coz windows does not understand otherwise)