Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 2.51 KB
Raw

Contributing to Secure Vault

We're thrilled you're interested in contributing to Secure Vault! Your contributions are valuable and help us make this project better for everyone.

Here's how you can get involved:

Reporting Issues

If you encounter a bug, have a feature request, or find something that needs improvement, please open an issue on GitHub:

  1. Check for existing issues: Search for similar issues to avoid duplicates.
  2. Provide clear details: Describe the issue concisely, including steps to reproduce it, expected behavior, and actual behavior.
  3. Attach relevant information: Include screenshots, logs, or code snippets if applicable.

Submitting Pull Requests

  1. Fork the repository: Create a fork of the Secure Vault repository on GitHub.
  2. Create a branch: Create a new branch for your feature or bug fix. Use a descriptive branch name.
  3. Make changes:
    • Code style: Follow the existing code style and conventions. Use consistent indentation and formatting.
    • Testing: Add or update unit tests to cover your changes.
    • Documentation: Update documentation as needed.
  4. Commit changes: Commit your changes with clear and concise commit messages.
  5. Push your branch: Push your changes to your forked repository.
  6. Create a pull request: Open a pull request from your branch to the main repository.
  7. Review and merge: Our team will review your pull request and provide feedback. Once approved, your changes will be merged into the main branch.

Code Style

  • Follow the existing code style and conventions used in the project.
  • Use consistent indentation and formatting.
  • Write clear and concise code.
  • Use meaningful variable and function names.

Testing

  • Write unit tests for all new code and ensure existing tests pass.
  • Use the provided testing framework and follow best practices for writing effective tests.

Documentation

  • Update documentation for any new features or changes.
  • Ensure documentation is clear, concise, and accurate.

Community Interaction

  • Be respectful and professional in all interactions.
  • Engage in constructive discussions and provide helpful feedback.
  • Use clear and concise language.

Code of Conduct

Please review our Code of Conduct for a comprehensive set of guidelines on respectful and inclusive behavior.

Thank You!

We appreciate your contributions! Your help makes Secure Vault a better project for everyone.