All documentation pertaining to how developers can contribute to NDS Labs.

New to NDS Labs?

Start here: New Developer Workflow

Overview

JIRA Workflows: Issue and project tracking
Git Workflows: Forking workflow with feature branches
1. Fork repo (if applicable)
  - Press "Fork" in GitHub UI
2. Clone repo to make changes locally (if applicable)
  - git clone https://github.com/USERNAME/ndslabs.git
  - git remote add upstream https://github.com/nds-org/ndslabs.git
3. Ensure correct branch and sync with upstream before making additional changes
  - git checkout master
  - git pull upstream master
4. Create a branch named after the Story (for example )
  - git checkout -b NDS-174
5. Make any necessary modifications locally on your branch
6. Stage any modified files for commit
  - git add path/to/modified/file.ext
7. Commit any modifications to your local branch with a comment
  - git commit -m "A comment about this commit"
8. Push any local commits back up to your remote branch (your forked repo)
  - git push origin NDS-174
9. When you are satisfied with your set of commits, create a Pull Request (PR) to view the diff
  - Press "Pull Request" in GitHub UI
  - Be sure to select the correct base and compare branches
    - Select nds-org/ndslabs as the base fork
    - Select master as the base branch
    - Select your personal fork (USERNAME/ndslabs) as the head fork
    - Select your personal Story branch as the compare branch
  - Scroll down and click on the "Files Changed" tab to briefly review your own Pull Request
    - Ensure that all changes made on this branch were intentional
    - If you are unsure about any specific code segments, comment in-line on the PR to ask for clarification
    - If you are unsure about any general concepts changed or introduced, comment in the section at the bottom of the PR
  - Name your Pull Request after the Story / branch (i.e. "NDS-174: User can access console of running service via CLI")
  - Enter a short description of any modifications, additions, or removals from the codebase
    - If applicable, include a Test Case that the reviewer should run before merging the Pull Request
  - Click "Create Pull Request"
Docker Workflows: Upload any necessary test images to Docker Hub
1. Build test image
  - docker build -t ndslabs/apiserver:dev .
2. Tag test image with Story id (i.e. NDS-174)
  - docker tag ndslabs/apiserver:dev ndslabs/apiserver:NDS-174
3. Push test image to Docker Hub
  - docker push ndslabs/apiserver:NDS-174
Kubernetes Workflows: Sometimes used in testing new services or the API server