When contributing to this repository, please first discuss the change you wish to make via an issue.
- Fork the repo: https://github.com/ivan-lednev/obsidian-day-planner
- Create a test vault and go to the plugins directory:
cd <your-vault>/.obsidian/plugins - Clone your fork with submodules. For my fork the command looks like this:
git clone --recurse-submodules https://github.com/ivan-lednev/obsidian-day-planner - Move to the folder:
cd obsidian-day-planner - Install dependencies:
npm install - Watch the changes:
npm run dev - Now when you change anything, reload Obsidian to see the updates
- You can use https://github.com/pjeby/hot-reload to make this process faster
- We don't want the repo to turn into a mess, so...
- Before committing, format your code with
npm run format. If you don't, the PR pipeline is going to mark the PR as failed once the maintainer triggers the PR workflow - Once you're ready to commit, make sure your commit message conforms to the conventional commits spec (pre-commit hook is going to fail otherwise)
- Before committing, format your code with
- Where appropriate, update the README.md with details of changes to the plugin, this includes additions and changes to configuration settings, plugin commands, useful file locations and additional installation instructions.
- If you can, please include tests in your Pull Request, particularly if you are making significant changes or additions to the behavior of the plugin.
- The repository maintainer will be responsible for increasing the version numbers in files and the README.md to the new version that this Pull Request would represent once it has been completed and merged.