Skip to content

Update README.md #4

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.

Sign up for GitHub

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

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

Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
![img](https://raw.githubusercontent.com/weaveVM/.github/main/profile/bg.png)

## WeaveVM RFCs
The "RFC" (request for comments) process is intended to provide a consistent and controlled path for new features for WeaveVM (WVM), so that all stakeholders can be confident about the direction the protocol is evolving in. Many changes, including bug fixes and documentation improvements, can be implemented and reviewed via the normal GitHub pull request workflow.
The "RFC" (Request For Comments) process is intended to provide a consistent and controlled path for new features for WeaveVM (WVM), so that all stakeholders can be confident about the direction the protocol is evolving in. Many changes, including bug fixes and documentation improvements, can be implemented and reviewed via the normal GitHub pull request workflow.

However, many changes are “substantial” and need to go through a design process and produce a consensus among the project stakeholders. The “RFC” (request for comments) process is intended to provide a consistent and controlled path for new features to enter the project.
However, many changes are “substantial” and need to go through a design process and produce a consensus among the project stakeholders. The “RFC” (Request For Comments) process is intended to provide a consistent and controlled path for new features to enter the project.

## Working with RFCs

Contributors and project stakeholders should consider using this process if they intend to make “substantial” changes to WeaveVM or its documentation. Some examples that would benefit from an RFC are:
Contributors and project stakeholders should consider using this process if they intend to make “substantial” changes to WeaveVM or its documentation. Some examples that would benefit from a RFC are:

* A new feature that creates new API surface area, and would require a feature flag if introduced.
* A new feature that creates new API surface area which would require a feature flag if introduced.

* The modification of an existing stable repository.

Expand All @@ -20,16 +20,16 @@ Contributors and project stakeholders should consider using this process if they

The RFC process is a great opportunity to get more eyeballs on proposals coming from contributors before it becomes a part of WeaveVM. Quite often, even proposals that seem “obvious” can be significantly improved once a wider group of interested people have a chance to weigh in.

The RFC process can also be helpful to encourage discussions about a proposed feature as it is being designed and incorporate important constraints into the design. At the same time, it’s easier to change, before the design has been fully implemented.
The RFC process can also be helpful to encourage discussions about a proposed feature as it is being designed and incorporate important constraints into the design. At the same time, it's easier to change, before the design has been fully implemented.

### Some changes do not require an RFC:

* Rephrasing, reorganizing or refactoring.

* Addition or removal of warnings, disclaimers, and others.
* Addition or removal of warnings, disclaimers and others.


The process in itself consists of creating a GitHub issue with the RFC label that documents the proposal thoroughly. There is an RFC template included in this repository that serves as a guideline for writing a new RFC.
The process in itself consists of creating a GitHub issue with the RFC label that documents the proposal thoroughly. There is a RFC template included in this repository that serves as a guideline for writing a new RFC.

## License
This repository is licensed under the [MIT License](./LICENSE)
Expand Down