Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 1.47 KB
Raw

Thank you for your interest in contributing to the pyZacros project!

How to contribute

We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Getting Started

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on master; git checkout -b fix/master/my_contribution master. Please avoid working directly on the master branch.
  • Make commits of logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are informative.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository in the SCM-NV organization.
  • The core team looks at Pull Requests on a regular basis.

Additional Resources