Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 1.78 KB

Contributing

First, thank you for reading this and taking the time to contribute.

Quick start

How do I report a bug?

Bugs are tracked as GitHub issues.

How do I suggest an enhancement?

You have two options:

  1. Follow the steps below under "How do I submit a patch?" or
  2. Submit a request as a GitHub issue

How do I submit a patch?

Please fork the repository on GitHub and submit a pull request. We go into more detail about this process or the alternatives in our documentation: How LumoSQL uses git and GitHub.

Testing

We provide a set of Linux container images for testing LumoSQL under different Linux distributions. We also run a small set of benchmarks before merging code in order to avoid performance regressions.

Style guides

For more details please see How LumoSQL uses git and GitHub in our documentation.

Commit messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • Please rebase as required, we have CI block merging commits that which start with fixup! or squash!

Pull requests

We are maintaining a semi-linear git history; we have automation and checks to help with this. The maintainers will help as a part of the review step.

Linters

A lot of our markdown is formatted with https://prettier.io; the JavaScript code in benchmarking/ uses ESLint and prettier.