Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 1.26 KB

Contributing to Shepherd

Help us make something great !

There are many ways you can help the project :

Report Issues

Please search the issue queue first. Others may have the same issue and have already found a solution or workaround.

File an issue if your problem looks new, list detailed steps to reproduce an issue and provide any other additional information (e.g development environment configuration)

Contribute Code

Read the Developers Guide

Development is done using the git flow branching model A successful Git branching model with the git-flow Git extension.

  • develop - development branch, Pull Requests should be submitted against it.

  • master - main stable branch, tagged releases created from this branch.

  • feature/feature-name - feature development happens here.

  • Fork the repo

  • Create a feature branch (this is optional)

  • Commit code with commit message, please explain what is in the commit :)

  • Create a pull request against develop

  • Discuss the PR openly

  • Once approved the PR will be merged