Skip to content

Latest commit

 

History

History
57 lines (31 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

57 lines (31 loc) · 1.26 KB
Raw

Contributing

Welcome

Welcome to this project. We want to thank you in advance if you wish to contribute to it.

Testing

To test the project you'll need to have a Game Maker Studio 2 license and run it with the play or debug button.

How to submit changes

To submit changes you need to create a branch from develop where you will be able to work on your feature or fix. When you’re done, you will have to create a pull request. Once reviewed, your branch may be merged in develop. See the PR and commit standards as well to keep the git clean 😉

PR and commit standards

Name of the branch

Your branch must be create from Pre-Prod using the following syntax :

  • If it’s a new feature :

feat/Name-of-the-Feature

  • If it’s a bug fix :

fix/Name-of-the-Fix

Commit standards

Your commit message always have to have the following nomenclature:

“[type]: your commit message”

The different types are:

  • Feature
  • Update
  • Fix
  • Remove
  • Refacto
  • Doc

For example: “Update: Reworked Enemy ”

PR standards

Your PR need to have the following nomenclature:

"[Type]: #[Issue] Name-of-the-PR"

Where the types are the same as the one used for the comits.

Disruptive Emojis

FOAD if you do this.