feat!(treewide): rewrite COC in TOML; introduce glossary #46
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Finished rewriting the CoC in the way I see fit for this format. I'll write up the Jinja template and you can review the new CoC from there. |
amadaluzia
force-pushed
the
toml
branch
6 times, most recently
from
36eee7d to
dd141e5
Compare
amadaluzia
force-pushed
the
toml
branch
6 times, most recently
from
7a23e10 to
544a05f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this break?
Nothing, but your workflow will certainly be hindered.
What does this PR change/add/delete?
This PR replaces the current Markdown used for the rules with a TOML format. This changes how rules are added to the COC. This also introduces a Python codebase meant to interact with CI to change the rules if edited to simplify the creation of new rules, rewording and whatnot.
I have also implemented a glossary system to get rid of sub-rule inconsistencies present in the COC.
Why?
Firstly, this allows for the code of conduct to be written into any language, such as HTML, Markdown and other markup languages. Secondly, it allows for a
rulecommand in our server without having to parse Markdown - which would be awful in my opinion. Lastly, it creates a standard for the rules so we don't have sub-rule inconsistencies or anything that looks unpleasant for everyone.