Skip to content

Latest commit

 

History

History
81 lines (44 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

81 lines (44 loc) · 2.05 KB
Raw

Contributing to Note-Vault

Thank you for considering contributing to Note-Vault. We welcome contributions from everyone willing to help improve the project or add new features.

Table of Contents

First Time Contributor

If you're new to contributing to open-source projects, here's a brief guide to get you started:

  • Check out the website to get an idea of the app.
  • Look through the list of issues to find something that interests you.

I Want To Contribute

Before starting, please:

  • Check for existing issues before creating a new one.
  • Only work on an issue if it has been assigned to you to avoid duplicate efforts.

Fork the Project

  1. Star & Fork this repository to create a local copy on your GitHub profile.

bash git clone https://github.com/Note-Vault/Note-Vault.git

Create a New Branch

  1. Create a new branch for your feature or bug fix.

bash git checkout -b branch_name

Work on the Issue Assigned

  1. Make your changes and add all necessary files.
  2. Stage your changes.

bash git add . or bash git add <file1> <file2>

Commit

  1. Commit your changes with a descriptive message.

bash git commit -m "Your descriptive commit message"

Push Local Changes

  1. Push your changes to your remote repository.

bash git push -u origin branch_name

Pull Request

  1. Go to your repository on GitHub and click on "Compare & pull requests".
  2. Add a title and description to your pull request.

Review

Wait for your pull request to be reviewed. Incorporate any feedback from the reviewers.