Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC] Formatting Conventions #1618

Open
1 task done
binex-dsk opened this issue Nov 25, 2023 · 2 comments
Open
1 task done

[RFC] Formatting Conventions #1618

binex-dsk opened this issue Nov 25, 2023 · 2 comments
Labels
rfc Request for comment

Comments

@binex-dsk
Copy link
Collaborator

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

  • I have searched the issue tracker and did not find an issue describing my suggestion, especially not one that has been rejected.

You may use the editor below to elaborate further.

No response

@binex-dsk binex-dsk added the rfc Request for comment label Nov 25, 2023
@xslendix
Copy link
Contributor

idk just throw the default clang format config in lol

@binex-dsk
Copy link
Collaborator Author

No

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rfc Request for comment
Projects
None yet
Development

No branches or pull requests

2 participants