contributing_to_ontaprestapi

Process for Contributing to the ONTAP REST API GitHub Repository

Version: March 25, 2020 This document describes a suggested process for how individuals can contribute to the NetApp ONTAP REST API code repository at GitHub. The process consists of a simple loop which is described below. There is also an appendix at the end with some common Git commands. After the repository becomes public, Jacob ([email protected]) will be able to administer the repository. Among other things, this involves reviewing changes and merging user branches to the master branch (based on pull requests).

Before you begin

• Make sure Git is installed on your local workstation
• Be familiar with the Git CLI (most of the commands are included in this document)
• Have an editor installed locally as needed to make content changes
• Have a GitHub account with access to the ONTAP REST API repository
• Access the repository at: https://github.com/NetApp/ontap-rest-api

General guidelines for branch, push, and merge operations

There are several ways that Git can be used and different ways to manage branches. Here are the suggested guidelines for the ONTAP REST API repository: Your local master branch should be in synch with the origin master branch

• Always create new branches from your local master for changes
• Local branches should: ** Have a unique and identifiable name ** Be pushed to the GitHub repository one time
• Be temporary and relatively short lived
• After a branch is pushed to GitHub and merged to master, it can be deleted