Contributing to pgvecto.rs
We welcome all kinds of contributions from the open-source community, individuals, and partners. If you're interested in contributing, hopefully, this document makes the process for contributing clear.
Contributors and people new to open source alike will find the following guides especially useful:
Code of conduct
A code of conduct is a document that establishes expectations for behavior for the project's participants. Adopting, and enforcing, a code of conduct can help create a positive social atmosphere for the community.
If you do not know what code of conduct is, please have a look at Your Code of Conduct | Open Source Guides.
Get involved
Our community is always looking for enthusiasts to help in all different ways.
⚽ Simply start using pgvecto.rs
Go through the Getting Started guide. Does everything work as expected? If not, we're always looking for improvements. Chat with us on 💬 Discord or file an issue on GitHub.
🙋 Triaging Issues and Pull Requests
One great way you can contribute to the project without writing any code is to help triage issues and pull requests as they come in.
- Ask for more information if you believe the issue does not provide all the details required to solve it.
- Suggest labels that can help categorize issues.
- Flag issues that are stale or that should be closed.
- Ask for test plans and review code.
👨💻 Contribute to pgvecto.rs
If you find an issue you would like to fix, open a pull request. Please read development tutorials to get started.
👉 Improve documentation
Everyone loves documentation. If you find anything that is confusing or can be improved, you can click "Edit this page" at the bottom of most docs, which takes you to the GitHub interface to make and propose changes.
💬 Discuss pgvecto.rs on Discord
Chat with us on 💬 Discord.