Table of Contents
If you would like to contribute to the development of dendron, checkout out the repo from github.
You can then follow the setup instructions.
- NOTE: the above setup instructions are for the dendron plugin. See the below links if you are working on a different part of Dendron:
A great place to start is with issues labelled with the size.small label on github. These are items that we picked out specifically for first time contributors and are small self contained task that are well suited for first time contributors.
Leave a comment in the issue if you decide to work on it. Issues that are being worked on will be assigned to a person already.
Remember that you are always welcome to ask for help inside the #dev discord channel.
We recently ( 2021.02.13 ) upgraded Dendron's backend to use Yarn Workspaces.
This comes with a bunch of performance and size improvements when developing Dendron.
If you currently have Dendron checked out, you'll need to run the following commands to migrate over to using the yarn build method.
# get latest version git pull npm install -g yarn # remove old node_modules ./bootstrap/scripts/cleanup.sh yarn bootstrap:bootstrap yarn bootstrap:build
First Time Developers
If you are interested in contributing to Dendron but haven't spent your career doing software, worry not. This is definitely something you can 🌱 into.
We have lots of resources to help you make your first contribution.
If you are completely new to software development, I would encourage you to look at the following resources:
- primer to typescript (everything in Dendron is based on this): https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html
When you are ready to make a contribution, you can follow the instructions in the development page
I'm also planning on streaming some dendron development on twitch in the coming weeks to show my workflow for working with Dendron and will give you a heads up when I'm doing them.
If you would like to contribute to the docs, you can do so by either making changes on github directly or by cloning our website repo and sending us a pull request.
If you would like to make a financial contribution to Dendron, you can do so by getting a Dendron environmentalist subscription.
Environmentalists are special members of our community that help to keep Dendron sustainable. They get access to early builds, priority support, and access to our dev channel.
You can sign up to be an environmentalist here.