A request for comments, or further referred to as "RFC" is a process intended to provide a consistent and controlled path for changes to be introduced to Cauldron.
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 provide a consensus among the Cauldron team.
You should follow this process if you intend to make substantial changes to Cauldron or its documentation. Some examples that would benefit from an RFC include:
- A new component or feature
- Any breaking changes
Some changes that would not need an RFC:
- Bug fixes
- Refactoring an existing component (while maintaining the same API contract)
- Rephrasing or clarifying documentation
- Create a new issue
- Add the
rfclabel - Be sure to include descriptive details, this includes:
- A descriptive title
- Implementation details
- Screenshots (if necessary for a new component)
The goal of our RFC process is to reach a consensus among the Cauldron team on proposed changes and to ensure that new features are congruent with the rest of Cauldron. The Cauldron team will have a recurring office hours meeting on the 1st Wednesday of each month, giving the team the opportunity to discuss any new RFCs that have been introduced and make comments. When an RFC is ready, a request for review can be posted in the #cauldron slack to request reviews for an RFC. Otherwise, RFCs will need a product owner's approval and at least 2 approvals from members of the Cauldron team.
Once a consensus has been reached for the proposed RFC, the rfc label will be removed from the issue and the proposed changes can then be implemented.