Thanks for being interested in contributing! We're so glad you want to help!
We want contributing to be fun, enjoyable, and educational for all. We love receiving contributions from our community, all contributions are welcome.
There are many ways to contribute. You can also help us by:
- Answering questions people have have in the forums
- Helping us build and design our website
- Cleaning up our existing documentation, polishing it, fixing our spelling or grammar mistakes, and so on
- Create new documentation
- Create an example of some changes / fixes/ hacks
- Creating blog posts, and tutorials about one of Vector's many features
- Reviewing submissions
- Contributing bits that can be incorporated into this or related projects.
Below you will find tips on how to get the most out of your contributing experience, including GitHub management tips, setup instructions for docs and code contributions, and more.
This repository is intended to hold packages that can be installed on Vector.
If you are worried or don't know where to start, you can reach out with questions to anyone from the Vector community at:
- Official Anki developer forums
- Anki robots Discord chat
- [GitHub Discussions][9] is directly integrated with the repository. You can use this to ask for help or share ideas related to improving the documentation or deploying it.
Below you'll find guides on our community, code of conduct, and how to get started contributing:
- Code of Conduct: Read about what we expect from everyone participating to make it the most friendly and welcoming community.
- Style Guide: The art of contributing, a.k.a. the detailed requirements that will make it more likely your contribution is accepted with minimal changes.
By participating in this project, you agree to abide by our Code of Conduct. We expect all contributors to follow the Code of Conduct and to treat fellow humans with respect.
The important documents and links are on the front page of the wiki.
If you have a suggestion for the documentation, we ask that you take a stab at making the changes to the documentation. Simple changes can often be made without a sophisticated pull release.
For large fixes, please build and test the documentation before submitting the pull-request to be sure you haven't accidentally introduced any layout or formatting issues.
Don't mix documentation changes with whitespace cleanup! If you are fixing whitespace, include those changes separately from your code changes. If your request is unreadable due to whitespace changes, it will be rejected.
Please submit whitespace cleanups in a separate pull request.
Don't mix rearranging the location and names of files with code or documentation changes! If you are rearranging the file system, please include those changes separately from your code changes.
Please submit file system changes in a separate pull request.
Please see the pull requests page for the process of submitting your changes to the prooject and incorporating feedback. are happy with your changes first!
[9]: https://github.com/digital-dream-labs/api/discussions)
Credits: This page was adapted from an EmbeddedArtistry template