Skip to content

Latest commit

 

History

History
115 lines (68 loc) · 4.09 KB

CONTRIBUTING.md

File metadata and controls

115 lines (68 loc) · 4.09 KB

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.

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.