PolyMC / PolyMC

A custom launcher for Minecraft that allows you to easily manage multiple installations of Minecraft at once (Fork of MultiMC)
https://polymc.org/
GNU General Public License v3.0
1.81k stars 267 forks source link

[RFC] Formatting Conventions #1618

Open ghost opened 10 months ago

ghost commented 10 months ago

Goal

Based on #1509

Now that PolyMC has diverged from Prism and MultiMC, there is no longer a need to keep backwards compatibility with either codebase. PolyMC needs to establish conventions for how we format our code.

Motivation

The PolyMC code is generally well put together, but many different developers have different standards for how they format stuff. In order to keep parity within code, we need to keep everything formatted identically.

Specification

Provide a strict set of standards for all things formatting. How we handle references and pointers, newline spacing, and more.

Drawbacks

It's impossible to force everyone to always go by the same standards. A random document on GitHub won't suffice.

Unresolved Questions

Should we adopt clang-format as our standard formatter?

How should we ensure every contributor sets up clang-format the same way?

Alternatives Considered

Simply running clang-format and having everyone follow whatever it does. See #1509.

This suggestion is unique

You may use the editor below to elaborate further.

No response

xslendix commented 10 months ago

idk just throw the default clang format config in lol

ghost commented 10 months ago

No