Thank you for your interest in contributing! As an open source project, we rely on developers like you to reimagine a version control system from scratch!
There are many ways to contribute, from reporting bugs and suggesting features to improving the code. We appreciate you taking the time to get involved.
If you encounter a bug or have a brilliant feature in mind, don't hesitate to open a new issue. To ensure a swift and effective response, please provide the following:
- Bug Reports: Include detailed steps to reproduce the issue, along with specifics about your operating system and Rust version, with screenshots and code/error snippets if required.
- Feature Requests: Provide a comprehensive explanation of how your idea benefits our version control system.
We welcome code contributions through pull requests. Here are some guidelines:
-
Before taking on significant code changes, please discuss your ideas by creating an issue to ensure they align with our projects vision. We want to keep the codebase simple and unintimidating for new users.
-
Fork the repository and create a new branch for your work.
-
Make changes with clear code comments explaining your approach. Try to follow existing conventions in the code.
-
Open a PR to
mainlinking any related issues. Provide detailed context on your changes. -
We will review PRs when possible and work with you to integrate your contribution. Please be patient as reviews take time.
-
Once approved, your code will be merged - thank you for improving Vault !