Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
32 lines (26 loc) 路 1.34 KB

CONTRIBUTING.md

File metadata and controls

32 lines (26 loc) 路 1.34 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Setup Process

  1. Fork the codotype repository to your GitHub account
  2. Clone your fork to your local computer
    e.g. $ git clone git@github.com:Apexal/codotype.git
  3. Add the original repository as the upstream remote
    $ git remote add upstream git@github.com:codotype/codotype.git

Development Process

  1. On the master branch, pull in any upstream changes
    $ git checkout master && git pull upstream master

  2. Create a new branch with a name reflecting its purpose

    • chore/<short-name> for chores
    • feature/<short-name> for new features
    • e.g. $ git checkout -b chore/add-contributing-docs

  3. Commit, commit, commit!

  4. Push your branch to your fork when ready
    $ git push origin

  5. Open a pull request

    List any Issues that you addressed in this branch so that they can be automatically closed