Contributing to Vault Web

Thank you for your interest in contributing to the Vault Web organization! 🚀

Vault Web is a modular, self-hosted home portal ecosystem. Contributions can include code, documentation, bug reports, feature requests, or testing.

---

How to Contribute

1. Fork & Clone

1. Fork the repository you want to contribute to.
2. Clone your fork locally:

git clone https://github.com/<your-username>/<repo>.git
cd <repo>

2. Create a Branch

• Always create a new branch for your changes:

git checkout -b feature/your-feature-name

• Use clear branch names: feature/xyz, bugfix/xyz, or docs/xyz.

3. Make Changes

• Follow existing code style and formatting.
• Include meaningful commit messages.
• Document any new features or changes clearly.

4. Testing

• Test your changes locally.
• Ensure existing functionality is not broken.

5. Submit a Pull Request

• Push your branch to your fork:

git push origin feature/your-feature-name

• Open a Pull Request to the original repository.
• Fill out the PR template if available.
• Ensure that all automated checks/workflows pass before requesting a review.
• Wait for review and feedback.

---

Issues

• If you find a bug or have a feature request, open an Issue in the respective repository.
• Use descriptive titles and detailed explanations.

---

Code of Conduct

• Be respectful and constructive.
• Follow the principles in the GitHub Community Guidelines.

---

Thank you for helping make Vault Web better! 💡