Skip to content

Latest commit

 

History

History
76 lines (67 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

76 lines (67 loc) · 2.27 KB
Raw

Contributing Guide

This document shows you how to get started contributing to this project.

Submitting changes

  • Fork the repository.

    • Click on the fork button.
    • Validate the fork creation.

  • Clone your fork by HTTPS or SSH method (as you prefer).

    # With HTTPS method
https://github.com/MyName/template.git

# With SSH method
git clone git@github.com:MyName/template.git

  • Check out a new branch based and name it to what you intend to do:

    Use one branch per fix / feature

    • Example: 
      git checkout -b feat/BRANCH_NAME
git checkout -b fix/BRANCH_NAME

  • Commit your changes

    • Please provide a git message that explains what you've done.

    • Please make sure your commits follow the conventions.

    • Commit to the remote repository.

    • Example:

      git commit -am 'feat(command): add a commit message'
git commit -am 'fix(permission): add a commit message'
        gitGraph
      commit
      commit
      branch feat/filter
      commit
      commit
      checkout main
      commit
      commit
      Loading

  • Push your changes to your fork.

    • Example: 
      git push origin BRANCH_NAME

  • Make a pull request when you are done with your changes.

    • Make sure you send the PR to the main branch.
      • title should follow the same convention as your commits.
      • description should follow the template (if exists) or be as descriptive as possible.
    • GitHub Actions are watching you!

If you follow these instructions, your PR will land pretty safely in the main repository!

gitGraph
    commit
    commit
    branch feat/filter
    commit
    commit
    checkout main
    commit
    checkout feat/filter
    merge main id: "merge main into feat/filter"
    checkout main
    merge feat/filter id: "merge feat/filter into main"
Loading