https://github.com/tidev/rfc
This is the official home of RFCs related to the TiDev foundation and related projects.
https://github.com/tidev/rfc
Last synced: 6 months ago
JSON representation
This is the official home of RFCs related to the TiDev foundation and related projects.
- Host: GitHub
- URL: https://github.com/tidev/rfc
- Owner: tidev
- Created: 2021-12-28T15:01:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-26T05:02:51.000Z (about 4 years ago)
- Last Synced: 2025-05-13T18:45:19.765Z (about 1 year ago)
- Size: 5.86 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# TiDev RFCs
This is the official home of RFCs related to the TiDev foundation and related projects.
An RFC is a technical specification that describes a problem and how it should be solved. A
committee will review the RFC and approve it. Once the RFC has been finalized, work may be
committed into the main project.
Any feature, architecture, or breaking change that is of substantial size or complexity must undergo
a technical review via an RFC.
The goal of creating an RFC is to solicit feedback and discussion. We all want to ensure that TiDev
projects are of the upmost quality.
## Contributor License Agreement (CLA)
All contributors must sign the TiDev CLA. You can review the latest version of the CLA on our
organization-docs Github repository here:
https://github.com/tidev/organization-docs/blob/main/CONTRIBUTOR_CLA.pdf
1. Contact Josh Lambert either via TiSlack or via email (josh.lambert@centrevilletech.com) and request an e-sign link containing the CLA. Make sure you include the email address in your message that you want to receive the e-sign request!
2. Complete the e-sign link when it arrives in your email from the TiDev Docusign account.
3. Your name will appear on the list below within 5 business days, at which point, you'll be eligible to submit code and other IP to the TiDev project.
> PLEASE NOTE: We only accept signed CLAs via Docusign to ensure we're all using the correct version of this document.
You do not need to sign a CLA to contribute to a RFC discussion.
## Submission Process
1. Fork the RFC repo: https://github.com/tidev/RFC
2. Create a branch for the new RFC
3. Copy the file `0000-template.md` to `doc/0000-.md`
4. Fill out the RFC
5. Submit a pull request
6. Wait for the TiDev contributors to review the RFC
## Review Process
Each RFC must be reviewed by at least one active TiDev maintainer. Only a TiDev maintainer is
permitted to accpet or reject an RFC pull request.
Once a RFC has been submitted, the RFC will be eventually be reviewed. The reviewers may ask for
clarification or a proof of concept.
An RFC may be eventually rejected if the RFC lacks information or justification. Please understand
that it is the duty of the TiDev foundation to ensure the feature or change is warranted and
thoroughly designed.
Please note that TiDev contributors are voluteers, we cannot guarantee the RFC will be reviewed in
a timely manner.
## RFC Lifecycle
Each RFC begins as a "draft" while the pull request is open. During this time, the RFC is discussed
and refined.
After review, the RFC becomes "accpeted" or "rejected".
When "accepted", the PR is merged and a ticket is the related project is created with a link to the
RFC. The RFC gets updated with the corresponding project ticket link. The project issue can then be
assigned to someone for implemetation.
When "rejected", the PR is closed. It is possible for a rejected RFC to be reopened if there is
new activity.