Skip to content

Latest commit

 

History

History
35 lines (30 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

35 lines (30 loc) · 1.92 KB

How to contribute

Setup

VSCode extensions

I suggest using the following VSCode extensions (ordered by importance):

Pull Requests

Every commit to the repository's main branche must be made from a pull request. You can create a branche if you are a member of the organization, or make a fork if you're not.

Code Conventions :

Prefix

The datapack's prefix is sgp. ; every namespace, objective or tag should start with this prefix

Entities Tags

When you call @e you shoud not forget to add tag=!global.ignore and also global.ignore.pos, global.ignore.gui and global.ignore.kill depending on the action you're doing, to prevent your command from interacting with potential entities from other datapacks. You should add the necessary tags to custom entities you create, and also add sgp.marker to markers for example, so that you can use @n[type=marker,tag=sgp.marker,name=<name>]

Function Documentation

Each fonction should be documented in the following way:

#> namespace:path/to/your/function 
# `{macro_param_a: optional_type, macro_param_b}`
# 
# Description of your function stating its purpose, inputs, and outputs. Wrap 
# at 80 characters.
#
# You can have multiple lines!

Language

The datapack is mainly written by French speakers for French speakers, but all new code should be written in English to prepare for future internationalization.