Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 2.51 KB

Contributing to PassVault - Password Manager

We are thrilled to have you contribute to PassVault! Your support and help are much appreciated, especially during Hacktoberfest 🎉.

Getting Started

Follow the steps below to set up the project locally:

Prerequisites

Frontend

Backend

Installation

  1. Fork the repository by clicking the "Fork" button on the top right of the repository page.

  2. Clone your forked repository locally:

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

There are two separate directories for frontend and backend, for more information please read there README files.

Contributing Guidelines

We follow a few guidelines to ensure a smooth collaboration:

  1. Fork and Clone: Fork the repository and make your changes in a new branch based on the main branch.

  2. Create new branch: Create new branch to keep code clean.

    git checkout -b feat/password-reset

  3. Commit Message Guidelines: Make sure your commit messages are clear and descriptive. Example:

    git commit -m "Implemented password reset feature"

  4. Testing: Ensure that all features are tested locally before making a PR.

  5. Pull Requests: Submit a pull request once your changes are tested and ready for review. Include a description of what was changed and why.

  6. Code Style: Follow the project's code style and make sure to lint your code with:

    bun run format

Issues

Browse open issues on the Issues tab. If you find one you'd like to work on, comment to let us know, and we'll assign it to you. Feel free to open new issues if you discover any bugs or have suggestions for improvements.

Feature Requests

If you have an idea for a feature or enhancement, feel free to open an issue to discuss it before working on it.

Hacktoberfest Contributions 🎃

All contributions during Hacktoberfest (October) are welcome! This includes bug fixes, new features, documentation improvements, and more. Just make sure to label your pull request with the hacktoberfest tag.