Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 1.22 KB
Raw

Contributing Guidelines

This document details the process you should follow when contributing code.

Overview

The master branch contains active development. It should be considered unstable. Versions are tagged in the repository.

Step by step

1. Fork the repository

Fork the repository on GitHub.

2. Clone the repository and checkout the master branch

git clone [email protected]/<your username>/orkestra-common.git
cd orkestra-common
git checkout master

3. Create a new feature branch.

In a contributor's case, a bug fix is still accomplished from a feature branch.

git checkout -b feature/new-and-awesome

4. Implement the feature, publish your feature branch to your forked repository

git add .
git commit -m "Made some changes"
git push origin feature/new-and-awesome

5. Create a pull request from your feature branch to the master branch of this project.

From your repository on the GitHub interface, click the pull request button. Select your feature branch and ensure the master branch of orkestra-common is selected.

Additional Info

This project tries to follow Semantic Version.