- Test the plugin's features
- Observe a bug or an improvement that could be made
- Report it by creating an issue
- If you have found a bug or a potential improvement for the plugin and want to code it, I would be happy to accept your PRs! Important : It'd be good to talk about it beforehand to make sure that no one else is working on it. You can open an issue for this.
- If you want to code but don't know where to start :
- Check out the issues labelled "help wanted".
- Check out
our roadmap(not available yet) and choose an unassigned task
Here are the steps to contribute to the Custom Classes's code :
- Fork this repository
- Clone your fork on your computer using
git clone https://github.com/<YourGithubName>/obsidian-custom-classes.git
- In local, navigate into the cloned folder called
obsidian-custom-classes/
- Add the Custom Classes project repository as the "upstream" remote using
git remote add upstream https://github.com/LilaRest/obsidian-custom-classes.git
- Now you can easily pull the new updates on the Custom Classes repository using
git pull upstream main
- Perform changes to your local repository
- Commit your changes using
git add -A
+git commit -m "<YourChangesDescription>"
- Push your changes to your fork repository using
git push origin main
- Return to your fork page on Github, refresh the page and you should see an highlighted area that invites you to initiate a Pull Request. (alternatively you can click on the "New pull request" button)