-
-
Notifications
You must be signed in to change notification settings - Fork 12
feat!(treewide): rewrite COC in TOML #46
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looking great so far
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. |
36eee7d
to
dd141e5
Compare
544a05f
to
37b88ec
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks great. not at liberty to approve/deny the rewrite of the coc itself but I do approve the code side. make sure we get actions set up to re-run the script and commit the new document every time a pr is merged
dd96ec8
to
580cde8
Compare
6447d1d
to
027a337
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add comments as neccssary, please respond as appropiate. LGTM otherwise, good work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oops, sent twice
4d87c20
to
dc90ac1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
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
rule
command 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.Notes
Closes #32