Vaultify Wiki ‐ Contributing - Vault-Tek/Vaultify GitHub Wiki

Overview

Vaultify is an open-source project, and we welcome contributions from the community! Whether you’re fixing bugs, improving documentation, adding new features, or suggesting enhancements, your contributions help make Vaultify better.

This guide outlines the best practices for contributing to Vaultify, ensuring smooth collaboration.

1. How to Contribute

🛠 1.1 Reporting Bugs

If you find a bug, please open an issue on the GitHub Issues page.
When reporting a bug, include:

  • A detailed description of the issue.
  • Steps to reproduce the problem.
  • Expected vs. actual behavior.
  • Any error messages or logs.
  • Your OS, browser, and Vaultify version.

🌟 1.2 Requesting Features

Have an idea for a new feature? Submit a feature request by opening a GitHub Issue.
Include:

  • A clear explanation of the feature.
  • Why it would be beneficial.
  • Any potential challenges or limitations.

💻 1.3 Submitting Code Contributions

If you’d like to contribute code, follow these steps:

Step 1: Fork the Repository

Click the Fork button at the top of the Vaultify GitHub page. This creates your own copy of the project.

Step 2: Clone Your Fork

git clone https://github.com/your-username/Vaultify.git
cd Vaultify

Step 3: Create a Branch

Always create a new branch for your changes:

git checkout -b feature/your-feature-name

Step 4: Make Changes

Edit the codebase and add your improvements. Be sure to follow the Vaultify coding standards and comment your code where necessary.

Step 5: Test Your Changes

Before submitting, test your changes locally:

npm run test

Ensure that all tests pass and that no existing functionality is broken.

Step 6: Commit and Push

git add .
git commit -m "Added feature X"
git push origin feature/your-feature-name

Step 7: Open a Pull Request

Go to the Vaultify repository and submit a Pull Request (PR) from your branch.

  • Clearly describe your changes.
  • Reference any related issues.
  • Request a review from the maintainers.

2. Coding Guidelines

Follow these best practices to ensure code consistency:
✅ Use meaningful commit messages (e.g., "Fixed login encryption bug").
✅ Write clean and well-documented code.
✅ Follow the existing project structure.
✅ Avoid committing unnecessary files (use .gitignore).

3. Improving Documentation

You don’t have to be a developer to contribute! Documentation is just as important as code.
Ways you can help:

  • Improve existing documentation.
  • Add missing details in the Wiki.
  • Fix typos and grammatical errors.

To contribute to the Wiki, fork the repository, edit the markdown files, and submit a pull request.

4. Code of Conduct

By contributing to Vaultify, you agree to follow our Code of Conduct, which ensures that all contributors:

  • Respect each other and communicate professionally.
  • Provide constructive feedback.
  • Avoid harassment, discrimination, or personal attacks.

5. Getting Help

If you need guidance:
📌 Check the Issues Page.
📌 Join the community discussions (Discord, Forums, etc.).
📌 Contact project maintainers via GitHub.