Contributing to Copilot for Obsidian

First off, thank you for considering contributing to Copilot for Obsidian! It's people like you that make Copilot for Obsidian such a great tool!

How Can I Contribute?

Reporting Bugs or Suggesting Enhancements

Before submitting a bug report or suggestion, check the issues page for a list of current known issues. Ensure the bug was not already reported by searching on GitHub.

If it's a new bug or suggestion, create an issue and provide the following information:

Use a clear and descriptive title.
Describe the exact steps which reproduce the problem in as much detail as possible.
Provide specific examples to demonstrate the steps.
Describe the behavior you observed after following the steps and point out what exactly is the problem.
Explain which behavior you expected to see instead and why.
Include screenshots or animated GIFs which show you following the described steps and clearly demonstrate the problem.

Your First Code Contribution

Unsure where to begin contributing to Copilot for Obsidian? You can start by looking through help-wanted issues.

Pull Requests

The process described here has several goals:

Maintain Copilot for Obsidian's quality
Fix problems that are important to users
Engage the community in working toward the best possible Copilot for Obsidian
Enable a sustainable system for Copilot for Obsidian's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

The code should adhere to a clean style that is consistent with the existing code.
Test your change thoroughly before submitting it.
Be descriptive in your pull request, link the issue it addresses, and show screenshots demonstrating the change.
Once you receive feedback, make sure to update the code accordingly to address them before your pull request can be ultimately accepted.

How to Setup Dev Environment

Here is a great writeup by Daniel Haven for the best practices setting up your dev environment for Obsidian plugins.

In the case of Copilot for Obsidian, you will need to

Fork the repo
Create a vault just for development
Clone the forked repo to your vault's plugins folder
Run npm run dev in your repo to see the effect of your changes
When you are ready to make a pull request, make sure to make your changes in a branch on your fork, and then submit a pull request to the main repo.

Try to be descriptive in your branch names and pull requests. Happy coding!

Getting Help

Discord: Join the server for Copilot dev discussions.
Email: logan@brevilabs.com.

Thank you for contributing to Copilot for Obsidian!

2.9 KiB Raw Blame History