Skip to main content

​
Contributing to Vault

We welcome contributions from the community! However, Vault follows a non-standard workflow that differs from typical open-source projects.

​
Non-Standard Workflow

This repository uses a non-standard workflow. Published commits may be rewritten or removed without notice as part of the debugging and improvement process.

​
No Pull Requests

Vault does not accept Pull Requests. Instead, all changes must be proposed via GitHub Issues. To contribute:
  1. Open a new GitHub Issue
  2. Clearly describe your proposed changes
  3. Explain the motivation and benefits
  4. Provide examples or use cases if applicable
  5. Wait for maintainer feedback

​
Why This Workflow?

This approach allows maintainers to:
  • Maintain tight control over code quality and project direction
  • Rewrite or remove commits as needed during development
  • Integrate changes in a way that fits the project architecture
  • Debug and improve code without worrying about breaking contributor commits

​
What Can You Contribute?

​
Bug Reports

  • Detailed reproduction steps
  • System environment information
  • Error messages and logs
  • Expected vs. actual behavior

​
Feature Requests

  • Clear description of the feature
  • Use cases and benefits
  • Potential implementation approach

​
Documentation Improvements

  • Typo fixes
  • Clarifications
  • Additional examples
  • Translation improvements

​
Testing and Feedback

  • Test experimental and beta projects
  • Report issues or edge cases
  • Share your experience using Vault projects

​
Project Lifecycle

Vault projects exist in different cycles. Check the project badge before contributing:
  • Experimental - May change without notice
  • Beta - Testing and minor adjustments ongoing
  • Release Candidate - Only critical fixes expected
  • Frozen - Development halted, no planned changes
  • Deprecated - Obsolete, no further updates

​
Code of Conduct

When contributing:
  • Be respectful and constructive
  • Follow issue templates
  • Search existing issues before creating new ones
  • Stay on topic
  • Be patient with maintainer responses

​
Recognition

We thank all those who have contributed to this project. / Agradecemos a todos los que han contribuido con este proyecto.
Contributors who provide valuable input, bug reports, or feature suggestions may be recognized in project documentation.

​
Third-Party Components

Vault includes third-party components. When proposing changes, be mindful of:
  • Existing licenses
  • Dependencies
  • Compatibility requirements
  • Attribution requirements

​
Getting Started

  1. Browse the project list
  2. Read individual project READMEs
  3. Review existing issues
  4. Join the community discussion
  5. Propose your contribution via Issues

​
Questions?

If you have questions about contributing, please:
  • Check the Support page
  • Review existing Issues
  • Open a new Issue with your question
Thank you for your interest in contributing to Vault!

Build docs developers (and LLMs) love

Get started for freeTalk to us