Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (37 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 2.75 KB
Raw

English · Oʻzbekcha

Contributing to FlakeForge

Thanks for being here. This guide covers how work happens across FlakeForge repositories. If a repository has its own CONTRIBUTING.md or AGENTS.md, those rules win.

Before you start

  • Read the Code of Conduct.
  • Search the open issues. Someone may already be on it, or the idea may have been discussed and turned down for a reason worth knowing.
  • For anything larger than a fix, open an issue first and describe what you want to change. Agreeing on the approach is cheaper than rewriting a finished pull request.
  • Questions are welcome in the Telegram group.

Working on a change

  1. Fork the repository and branch off main.
  2. Read the repository README before writing code. Most of our projects use a justfile; run just to see the recipes. Do not invent a script when a recipe exists.
  3. Match the code around you. Naming, formatting and folder structure are already decided; a pull request that reformats unrelated files is hard to review.
  4. Run the project's lint, type check and tests before you push. If a repository documents a single command for this, use that one.
  5. Keep one pull request to one subject.

Commits

We use Conventional Commits in English.

feat(web): add a gradient angle control
fix(bot): reply in groups only when mentioned
docs: correct the setup steps

Several repositories check this in a git hook, so a wrong subject line will stop the commit.

Pull requests

Describe what changed and why. Link the issue with Closes #123. Screenshots or a short screen recording help for anything visible.

A maintainer reviews it. Review comments are about the code, not about you, and pushing back with a technical reason is part of the process. Pull requests are squash merged.

Documentation and translations

Text in our repositories is written in English first. Uzbek uses the Latin script, and Russian is written for native readers rather than translated word for word.

Documents that exist in two languages, such as README.md and README.uz.md, are updated in the same pull request. A change that lands in one language only is incomplete.

Beyond code

Documentation, translations, design review, accessibility findings and a reproducible bug report are all contributions. Issues labelled good first issue need no prior knowledge of the codebase; help wanted marks what we would most like help with.

Security

Do not report a vulnerability in a public issue. SECURITY.md explains the private channel.

License

Each repository states its license. By contributing you agree your work is released under that license.