Many changes, including bug fixes and documentation improvements can be implemented and reviewed via the normal GitHub pull request workflow.
Some changes though are "substantial", and we ask that these be put through a bit of a design process and produce a consensus among the TiKV community.
The "RFC" (request for comments) process is intended to provide a consistent and controlled path for new features to enter the project, so that all stakeholders can be confident about the direction the project is evolving in.
- Copy
template.mdintotext/PRID-my-feature.md. - Write the document and fill in the blanks.
- Submit a pull request.
- An RFC is submitted as a PR.
- Discussion takes place, and the text is revised in response.
- The PR is accepted or rejected when at least two project maintainers reach consensus.
- If accepted, create a tracking issue, refer it in the RFC, and finalize by merging.
We follow lint rules listed in markdownlint.
Run lints (you must have Node.js installed):
# Install linters: npm install
npm run lintThis content is licensed under Apache License, Version 2.0, (LICENSE or http://www.apache.org/licenses/LICENSE-2.0)
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.