6 Dendron Design System
This is the place to propose and track major upcoming changes to Dendron and other related projects. It also is a great place to learn about the current and future state of the system and to discover projects for contribution.
Jump to: What is an RFC? | When to submit? | RFC States |
|✅ done||7 Graph Rework||@HFellerhoff|
|✅ done||10 Blocks||@SeriousBug|
|✅ done||1 - Native Preview Experience||@kevin|
|✅ done||16 Better Tags||@SeriousBug|
|1️⃣ phase one done||(draft)11 Better Tree View||@kevin|
|1️⃣ phase one done||14 - The Seed Bank||@kevin|
|1️⃣ phase one done||18 Add Note Indexes||@hikchoi|
|1️⃣ phase one done||9 Note Lifecycle Hooks||@kevin|
|1️⃣ phase one done||2 Managed Publishing||@kevin|
|👷 implementing||22 Queries||@SeriousBug|
|👷 implementing||13 - Task Notes||@kevin|
|👩🌾 community issue||20 - Integrated Space Repetition||@kevin|
|💡 proposed||12 Schema Improvements||@kevin|
|💡 proposed||3 Standalone Vaults||@kevin|
|💡 proposed||4 Richer Templating||@kevin|
|💡 proposed||5 Publishing Registry||@kevin|
|💡 proposed||6 Dendron Design System||@kevin|
|💡 proposed||8 Multi Publish||@kevin|
|💡 proposed||20 - Integrated Space Repetition||@imalightbulb|
|💡 proposed||28 Notifications||@SeriousBug|
|💡 proposed||RFC 40 - Dendron Plugins||@SeriousBug|
|💡 proposed||42 Self Contained Vaults||@SeriousBug|
|💡 proposed||43 Refactor Logs|
|💡 proposed||44 Standard srcfieldMapping for all pods||@Harshita-mindfire|
|draft||15 Browser Based Dendron||@kpats|
|👷 implementing||38 - Links to files that are not notes||@SeriousBug|
An RFC is a document that proposes and details a change or addition to Dendron and other related tooling. It is also a process for reviewing and discussing the proposal and tracking its implementation. "Request for Comments" means a request for discussion and oversight about the future of Dendron from contributors and users. It is an open forum for suggestions, questions, and feedback.
The process is intended to be as lightweight and reasonable as possible for the present circumstances. As usual, we are trying to let the process be driven by consensus and community norms, not impose more structure than necessary.
The RFC process itself is subject to changes as dictated by the core team and the community. Proposals can include proposed changes to the RFC process itself to better serve contributors.
You should consider using this process if you intend to make "substantial" changes to Dendron or related tools. Some examples that would benefit from an RFC are:
The RFC process is a great opportunity to get more eyeballs on your proposal before it becomes a part of a released version of Dendron. 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 while it's easier to change, before the design has been fully implemented.
If you submit a pull request to implement a new major feature without going through the RFC process, it may be closed with a polite request to submit an RFC first.
Some changes do not require an RFC:
If you're not sure whether your change requires an RFC, feel free to create an issue and ask.
In short, to get a major feature added to Dendron, one usually writes an RFC as a markdown file and gets it approved and mergd into the Dendron-site. At that point the RFC is 'in review' and may be implemented.
<my-feature>is the rfc title.
RFC: ### <title>where ### is the tracking issue number and title is the name of the proposal. As a pull request the RFC will receive design feedback from the core team and the larger community, and the author should be prepared to make revisions in response.
If the submitter is someone from our community (i.e., not core team member), a core team member will be assigned to 'shepherd' each proposal. They will generally be the ones updating the RFCs state in the tracking issue as it moves through the process. They can decide when a final comment period is triggered.
master, and the RFC is now ready to be implemented.
Dendron's RFC process looks up to AWS CDK RFC process, Yarn RFC process, Rust RFC process, React RFC process, and Ember RFC process