Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (28 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 2.51 KB
Raw

Contributing

Thanks for taking the time. This file is the default for every repository in the Lavder Enterprise organisation; a repository with its own CONTRIBUTING.md overrides it.

First, which kind of repository is this?

Most of this organisation is client work and is private. What is public falls into two groups, and they take contributions differently.

Release feeds (*-releases) hold published binaries and update manifests, not source. Bug reports and feature requests are welcome there. Pull requests are not — there is nothing to patch.

Everything else public takes pull requests under the rules below.

Before you write code

Open an issue first for anything larger than a typo. A short description of the problem, and what you intend to do about it, saves both of us the case where we were already halfway through the same work or had ruled that approach out.

For a bug, the fastest path to a fix is a reproduction: version, platform, exact steps, what you expected, what happened.

Pull requests

  • Branch from the default branch and keep the pull request to one concern. Two unrelated fixes are two pull requests.
  • Match the surrounding code. Naming, structure and comment density that look like the file you are editing, not like a different project.
  • Explain the why in the description. The diff already shows the what.
  • Say what you ran. The commands and the result. "Should work" is not a test.
  • Do not commit secrets, .env files, credentials, tokens, client data or customer names. Anything committed to a public repository is public permanently, including from a branch you later delete.

We review for correctness first, then clarity, then everything else. Expect direct comments; they are about the code.

Commit messages

Conventional commits, present tense, one logical change per commit:

feat(parser): support multi-line front matter
fix(auth): reject expired tokens before refresh
docs: correct the install path for Apple silicon

Licensing

Unless the repository states otherwise, its code is proprietary to Lavder Enterprise S.R.L. and the LICENSE file at the repository root governs. Sending us a pull request means you have the right to contribute that code and you are licensing it to us under the same terms as the rest of the repository.

Not a code contribution?

Security problems do not belong in issues or pull requests. Follow SECURITY.md.

Commercial enquiries, partnerships and white-label work: info@lavder.com.