Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (39 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 1.82 KB

Knox Help Contributing Guide

There's two areas of Contribution

To Knox

Apache Knox

  1. Read the Apache Knox Contribution Process
  2. Setup a GitHub account, and generate add an SSH Key.

Get the Code

  1. git clone git@github.com:mcparlandjcgi/knox-help.git
  2. chmod u+x *.sh
  3. ./knox_env_setup.sh - NOTE: This will
  4. Clone John's fork setting it as origin
  5. Clone Apache Knox Official setting it as upstream

Modifying Knox

  1. Branch by feature/ticket
  2. Work against origin (which is John's fork)
  3. As a team, we'll decide when to merge into upstream (which is Apache Knox Official)

Merging Upstream Into Origin

Based around Atlassian Blog on Git Forks and Upstreams.

  1. Assumes origin is John's fork
  2. Assumes upstream is Apache Knox Official
git fetch upstream
git checkout master
git merge upstream/master

To This Repository

Get the Code/Docs

If not already, get the code/documents.

  1. git clone git@github.com:mcparlandjcgi/knox-help.git
  2. chmod u+x *.sh

Modify the Code/Docs

  1. Create a new issue on GitLab.
  2. Branch Branch by feature/ticket
  3. Get a pull review.