Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

16 lines (12 loc) · 1.14 KB

Contributing Guidelines

This page will outline the guidelines for contributing properly to the project

Committing Guidelines:

- Commits must be buildable
- Changes in a single commit must be relavent, so no putting random changes in the audio code while naming the commit "Add new input method"
- Commits must follow the formatting of the project, so make sure to run a formatter using the EditorConfig before committing
- Commit names should always follow the naming guidelines

Commit Naming Guidelines

All commits should follow the basic structure of "SystemChanged: WhatChanged", so an example would be "Audio: Fix pitch check", if the commit changes multiple systems, then you would write it out as "Audio + FurballTestGame: Add frequency changing test"

Note on merge commits: Please do not name merge commits "merge x into y", please explain why you are merging x into y

Pull Requests

If code is to be merged back upstream, all CI checks should pass and all guidelines should be met, with exceptions being given in cases where matching the guidelines would not be possible