Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

amadaluzia
Copy link

@amadaluzia amadaluzia commented Jun 23, 2025

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

@anemoijereja-eden anemoijereja-eden self-assigned this Jun 23, 2025
Copy link

@anemoijereja-eden anemoijereja-eden left a 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

@amadaluzia
Copy link
Author

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 amadaluzia force-pushed the toml branch 6 times, most recently from 36eee7d to dd141e5 Compare June 23, 2025 22:02
@amadaluzia amadaluzia closed this Jun 23, 2025
@amadaluzia amadaluzia reopened this Jun 23, 2025
@amadaluzia amadaluzia marked this pull request as ready for review June 24, 2025 01:16
@amadaluzia amadaluzia force-pushed the toml branch 7 times, most recently from 544a05f to 37b88ec Compare June 24, 2025 18:37
Copy link

@anemoijereja-eden anemoijereja-eden left a 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

@amadaluzia amadaluzia force-pushed the toml branch 8 times, most recently from dd96ec8 to 580cde8 Compare June 30, 2025 07:40
@amadaluzia
Copy link
Author

@anemoijereja-eden Added workflows, just need it reviewed atm.

@amadaluzia amadaluzia force-pushed the toml branch 5 times, most recently from 1c5f981 to b6be589 Compare June 30, 2025 08:50
@Atmois Atmois self-requested a review August 10, 2025 20:34
@amadaluzia amadaluzia force-pushed the toml branch 2 times, most recently from 931abc6 to 49f5065 Compare August 10, 2025 21:29
@amadaluzia
Copy link
Author

Rules have been updated to match the currently displayed rules.

@amadaluzia amadaluzia force-pushed the toml branch 2 times, most recently from 6b5e09a to 409911f Compare August 10, 2025 22:04
@Atmois Atmois changed the title feat!(treewide): rewrite COC in TOML; introduce glossary feat!(treewide): rewrite COC in TOML Aug 10, 2025
@amadaluzia amadaluzia force-pushed the toml branch 4 times, most recently from c2b939d to 41754c9 Compare August 10, 2025 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Select new github actions workflow for table of contents
2 participants