Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 1023 Bytes

How-to-Contribute.md

File metadata and controls

23 lines (19 loc) · 1023 Bytes
Raw

How to Contribute

Encore is an open source project and anyone is welcome to contribute. However, please make sure your changes are relevant to all users to avoid bloating the common code. If you're unsure, create an issue to discuss. Also, please abide by the style guide.

Instructions

One-time Setup

  1. Fork the encore-matlab repository
  2. Clone your personal fork to your computer:
    git clone https://github.com/YOUR_USERNAME/encore-matlab.git
  3. Add a remote repository:
    git remote add upstream https://github.com/Encore-DMS/encore-matlab.git

General Workflow

  1. Sync your repo:
    git pull upstream master
  2. Create a topic branch:
    git checkout -b TOPIC_BRANCH_NAME master
  3. Make changes and commit:
    git commit -am "A description of my changes." or git commit -am "[fixed #ISSUE_NUM] description" (if fixing an issue tracked in GitHub)
  4. Push to GitHub:
    git push origin TOPIC_BRANCH_NAME
  5. Submit a pull request