chore: clean up repository metadata (#1571)

2026-10-07 19:22:14 +09:00 · 2026-08-12 14:50:00 +02:00
parent c42f38caf1
commit a9a51f576c
28 changed files with 557 additions and 628 deletions
@@ -1,13 +1,91 @@
-# Contributing
+# Contributing to Fluxer

-When you make a pull request, you must be able to understand, explain, defend, etc. the proposed changes.
+This policy applies to all issues, discussions, commits and pull requests.

-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.
+## Scope

-If you use LLMs for coding help, please disclose it. The contribution still needs to be understandable, reviewable, and tested well.
+To prevent spam, only approved contributors may submit pull requests.

-## Style guidelines
+To request approval, comment on an existing issue and ask to implement it. For work that extends beyond a defect fix, open a [discussion](https://github.com/orgs/fluxerapp/discussions) first.

-When not using proper nouns, Fluxer prefers sentence case over title case.
+Every pull request must:

-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.
+- Target the repository's default branch.
+- Include a closing reference for each repository issue it resolves.
+- Receive approval from a maintainer before it is merged.
+
+Place each closing reference on a separate line:
+
+```text
+Closes #123
+Closes #456
+```
+
+## Authorship
+
+You must understand every line you submit and be able to explain why the change is correct.
+
+The [LLM usage policy](LLM_USAGE_POLICY.md) defines the authorship requirements for contributors who do not have write access.
+
+Each contribution must contain one coherent change. Do not include unrelated fixes, refactoring or formatting changes.
+
+## Commit requirements
+
+Every commit made by a contributor must include:
+
+- A Developer Certificate of Origin sign-off.
+- A cryptographic signature that GitHub marks as verified.
+
+Pull requests opened by Fluxer repository automation are exempt from these commit requirements.
+
+Read the [Developer Certificate of Origin 1.1](https://developercertificate.org) before contributing. Add a `Signed-off-by` trailer by creating the commit with `git commit -s`. The name and email address in the trailer must match those of the commit author or committer.
+
+## Pull request requirements
+
+Pull request titles must contain no more than 72 characters and use the following format:
+
+```text
+type(optional-scope): imperative subject
+```
+
+The permitted types are:
+
+- `feat`
+- `fix`
+- `docs`
+- `style`
+- `refactor`
+- `perf`
+- `test`
+- `build`
+- `ci`
+- `chore`
+
+For a breaking change, place `!` immediately before the colon:
+
+```text
+type(optional-scope)!: imperative subject
+```
+
+Prefix the title of a revert with `revert: `.
+
+Complete every section of the pull request template. Clearly describe:
+
+- What the change does.
+- Why the change is correct.
+- What risks it introduces.
+- How it was verified.
+
+## Reports and other contributions
+
+Use the [bug report form](https://github.com/fluxerapp/fluxer/issues/new?template=bug-report.yaml) to report reproducible defects.
+
+Report security vulnerabilities privately through the channels specified in the [security policy](SECURITY.md). Do not report vulnerabilities in public issues or discussions.
+
+Use [discussions](https://github.com/orgs/fluxerapp/discussions) for feature proposals and self-hosting questions.
+
+Submit translations through [Weblate](https://weblate.fluxer.tools), not through pull requests.
+
+All repository activity is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+Fluxer is distributed under the [GNU Affero General Public License, version 3.0 or later](../LICENSE). By adding a DCO sign-off, you certify that you have the right to submit the contribution under that licence.