From 6064bdf0e764fb4b30dceffb8de0d79beef368f0 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Fri, 10 Jul 2026 15:28:22 +0100 Subject: [PATCH] chore: update style guidelines (#1359) --- .github/CONTRIBUTING.md | 13 +++++++++++++ CONTRIBUTING.md | 7 ------- 2 files changed, 13 insertions(+), 7 deletions(-) create mode 100644 .github/CONTRIBUTING.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..c88e868d8 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing + +When you make a pull request, you must be able to understand, explain, defend, etc. the proposed changes. + +Keep AI-generated text out of bug reports, pull request descriptions, and GitHub comments. Direct translation is permissible if you are not comfortable with your English skills. + +If you use LLMs for coding help, please disclose it. The contribution still needs to be understandable, reviewable, and tested well. + +## Style guidelines + +When not using proper nouns, Fluxer prefers sentence case over title case. + +For example, "Bug Hunter" should be capitalised as it is a proper noun. Strings in a modal's title, heading, etc. should always be sentence case otherwise. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 62c356e3d..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,7 +0,0 @@ -# Contributing - -Understand every change in your PR. You should be able to explain what it does and why it is correct. - -Keep AI-generated text out of bug reports, pull request descriptions, and GitHub comments, except for direct translation if English is not your native language. - -If you use LLMs for coding help, disclose it. The contribution still needs to be understandable, reviewable, and tested well.