Development Process

Summary

This goes over the end to end lifecycle of handling issues in Dendron - from the moment an issue is conceived to after it has been deployed in production.

• TIP: if you have questions about any of this, the best place to go for help is inside the Dendron Discord [#dev (Private) channel] (https://discord.gg/AE3NRw9)

Planning

Issues

Managing new tasks and issues

• Github Issues
• Internal Issues (Private)

Execution

Code

Writing code

• Foundational: read this before you start working
  • Dev Env: Setting up your dev environment
  • Monorepo (NOTE: read this if its your first time working in a monorepo)
  • Tips
• Process
  • Code Conventions
  • Best Practices When Coding
  • Impactful Change Notice: Breaking changes to the development process and current migrations
• Helpful
  • Utilities: Where utilities are stored
  • Gotchas: Gremlins that can be hard to debug
  • Cookbook: Howto perform common operations

Instrumentation

• Errors
• Logs

Tests

• Testing

Docs

• Dendron Developer Docs
• Dendron Product Docs

Commit

• Committing Code

Review

• Submitting Code for Review
• Additional Review Considerations (Private)

Release

Releasing Code

• Deployments

Feedback

Close the Loop

Things to do after issue is released

• Close Loop

Repot

These are misc notes that need to be re-organized:

• Cookbook

Lookup

• the layout is inspired by GitLab Master Plan

---

Backlinks

• Contributing (Private)
• Development
• Dendron Plugin Quickstart