Skip to content
Arbinel

Contributing

Anyone can contribute to Arbinel, with or without the help of a large language model. You do not need to use CodeFloe or contribute to Forgejo first.

Code

Section titled “Code”

Arbinel’s source is in arbinel/arbinel on codefloe.com. Read these two files before you open an issue or a pull request:

  • The README describes which contributions Arbinel accepts, the conditions for LLM-assisted work, and how the licensing works.
  • CONTRIBUTING.md covers setting up a checkout, where code goes, commit and pull request conventions, and the review process.

Arbinel builds and tests like Forgejo, so Forgejo’s contributor guide applies for building and running the test suites. Report or fix a bug in Forgejo’s own code in Forgejo first. Arbinel gets the fix with the next Forgejo merge.

Report security vulnerabilities in Arbinel’s own code privately to security@arbinel.com, not in a public issue.

Documentation

Section titled “Documentation”

The source of this site is in arbinel/docs. Every page has an edit link at the bottom. The repository’s README explains how to build the site and check your writing.

Scope

Section titled “Scope”

This documentation does not repeat Forgejo’s documentation. A page covers one of two things:

  • What Arbinel adds to or changes from Forgejo.
  • A Forgejo topic whose page in Forgejo’s documentation is unclear or incomplete enough that readers cannot follow it.

For everything else, link to the Forgejo page. If a Forgejo page is wrong or unclear for every Forgejo user, consider fixing it in Forgejo’s docs too.

Accuracy

Section titled “Accuracy”

Every configuration key, default, API path and interface label comes from Arbinel’s source code. Quote defaults as the code sets them. If you cannot verify a claim, leave it out. When Arbinel changes a feature, update its page here.

Style

Section titled “Style”
  • Write one sentence per line.
  • Use plain English and short sentences, and the imperative for steps.
  • Call the product Arbinel. Keep codefloe where it is part of a real identifier, such as [codefloe.ratelimit.<name>] or the codefloe-tide-auto theme.
  • Run just lint-prose and fix what Vale reports. If Vale rejects a correct word, add it to .vale/config/vocabularies/arbinel/accept.txt.