obsidian-plugin/logancyang_obsidian-copilot
1
0
Fork 0
mirror of https://github.com/logancyang/obsidian-copilot.git synced 2026-07-22 07:50:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update CONTRIBUTING.md (#228)

Browse source 
Co-authored-by: Peter Yang <nidaye@qianlis-air.lan>
This commit is contained in:
Peter Yang 2024-01-09 12:01:05 -08:00 committed by GitHub
parent b5b3934640
commit 13cc07aecd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
CONTRIBUTING.md
View file

@ -1,58 +1,58 @@
# 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!
First off, thank you for considering contributing to Copilot for Obsidian! It's people like you who 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](https://github.com/logancyang/obsidian-copilot/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:
Before submitting a bug report or suggestion, please check the [issues](https://github.com/logancyang/obsidian-copilot/issues) page for a list of currently known issues to ensure the bug has not already been reported. 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.
- Provide specific examples to demonstrate these steps.
- Describe the behavior you observed after following the steps, pointing 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.
- Include screenshots or animated GIFs showing you following the described steps and clearly demonstrating the problem.
### Your First Code Contribution
Unsure where to begin contributing to Copilot for Obsidian? You can start by looking through `help-wanted` issues.
Unsure where to begin contributing to Copilot for Obsidian? You can start by looking through the `help-wanted` issues.
### Pull Requests
The process described here has several goals:
The process described here aims to:
- 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
- Maintain the quality of Copilot for Obsidian.
- Fix problems that are important to users.
- Engage the community in working towards 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:
1. The code should adhere to a clean style that is consistent with the existing code.
2. Test your change thoroughly before submitting it.
3. Be descriptive in your pull request, link the issue it addresses, and show screenshots demonstrating the change.
4. Once you receive feedback, make sure to update the code accordingly to address them before your pull request can be ultimately accepted.
1. Ensure the code adheres to a clean style consistent with the existing code.
2. Thoroughly test your changes before submitting.
3. Be descriptive in your pull request, linking to the issue it addresses, and showing screenshots demonstrating the change.
4. Once you receive feedback, 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](https://medium.com/gitconnected/how-to-set-up-the-ideal-obsidian-plugin-development-workflow-b222fe72280f) for the best practices setting up your dev environment for Obsidian plugins.
### How to Set Up Dev Environment
In the case of Copilot for Obsidian, you will need to
Here is a great [writeup by Daniel Haven](https://medium.com/gitconnected/how-to-set-up-the-ideal-obsidian-plugin-development-workflow-b222fe72280f) on the best practices for setting up your dev environment for Obsidian plugins.
1. Fork the repo
2. Create a vault just for development
3. Clone the forked repo to your vault's `plugins` folder
4. Run `npm run dev` in your repo to see the effect of your changes
5. 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**.
In the case of Copilot for Obsidian, you will need to:
1. Fork the repo.
2. Create a vault just for development.
3. Clone the forked repo into your vault's `plugins` folder.
4. Run `npm run dev` in your repo to see the effect of your changes.
5. When you are ready to make a pull request, ensure 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](https://discord.gg/CYDvNtGHkQ) the server for Copilot dev discussions.
- **Email**: logan@brevilabs.com.
- **Email**: logan@brevilabs.com
Thank you for contributing to Copilot for Obsidian!