mirror of
https://github.com/fluxerapp/fluxer.git
synced 2026-09-02 21:04:06 +03:00
chore: update style guidelines (#1359)
This commit is contained in:
@@ -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.
|
||||
@@ -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.
|
||||
Reference in New Issue
Block a user