Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[590] Add RFC template for XTable #604

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vinishjail97
Copy link
Contributor

Important Read

  • Please ensure the GitHub issue is mentioned at the beginning of the PR

What is the purpose of the pull request

Introduce RFC template to propose/review new technical specs in the project.

Brief change log

(for example:)

  • Add RFC template

Verify this pull request

(Please pick either of the following options)

This pull request is a trivial rework / code cleanup without any test coverage.


## Implementation
Describe the new thing you want to do in appropriate detail, how it fits into the project architecture.
Provide a detailed description of how you intend to implement this feature.This may be fairly extensive and have large subsections of its own.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to add \ at the end of a line or else it is rendering as own.Or


## Rollout/Adoption Plan

- What impact (if any) will there be on existing users?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we call out any breakage to existing APIs?


## Abstract

Describe the problem you are trying to solve and a brief description of why it’s needed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: add a .

Describe the problem you are trying to solve and a brief description of why it’s needed

## Background
Introduce any much background context which is relevant or necessary to understand the feature and design choices.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any much -> any

- What impact (if any) will there be on existing users?
- If we are changing behavior how will we phase out the older behavior?
- If we need special migration tools, describe them here.
- When will we remove the existing behavior
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Combine this with 49?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants