-
Notifications
You must be signed in to change notification settings - Fork 169
RFC#: Template
Jesse Mapel edited this page Nov 18, 2021
·
3 revisions
- Feature/Process Name: (Name of this RFC)
- Start Date: (Today's Date)
- RFC PR: (empty until a PR is opened)
- Author: (your name)
Include a brief summary of the RFC so readers can determine if the RFC is of interest.
Why are we doing this? What use cases does it support? What is the expected outcome?
Explain the proposal as if it were already included in the code base or in place. This may mean:
- Introducing new named concepts.
- Explaining changes in terms of example usage.
- Explaining how developers or consumers might think about a new feature. Conceptually what is changing?
- If applicable, what might sample error messages, deprecation warnings, or migration guidance look like?
- If applicable, how might this alter current workflows or processes?
- If applicable, a more technical portion that describes:
- how the feature might interact with other features
- what the system architecture might look like
- how testing might be done
- what corner cases could exist that are not covered
- this section should link back to the examples provided above
Why should we not do this?
- Why is this design or solution the best of all possible solutions?
- What other designs have been considered and what is the rationale for not choosing them?
- What is the impact of not doing this?
- What parts of the design will be merged through the RFC process prior to merging?
- What parts of the RFC are expected to be addressed through implementation before stabilization?
- What related issues are out of scope for this RFC, but could be addressed in future RFCs?
- What future extensions could be made from this RFC?
- What other ideas might you have? This is a great place to 'dump related ideas'.
- Building
- Writing Tests
- Test Data
- Start Contributing
- Public Release Process
- Continuous Integration
- Updating Application Documentation
- Deprecating Functionality
- LTS Release Process and Support
- RFC1 - Documentation Delivery
- RFC2 - ISIS3 Release Policy
- RFC3 - SPICE Modularization
- RFC3 - Impact on Application Users
- RFC4 - Migration of ISIS Data to GitHub - Updated Information 2020-03-16
- RFC5 - Remove old LRO LOLA/GRAIL SPK files
- RFC6 - BLOB Redesign
- Introduction to ISIS
- Locating and Ingesting Image Data
- ISIS Cube Format
- Understanding Bit Types
- Core Base and Multiplier
- Special Pixels
- FAQ