Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.54 KB
Raw

How to contribute

I love to welcome your contributions. There are several ways to help out:

  • Create an issue on GitHub, if you have found a bug
  • Write test cases or provide examples for open bug issues
  • Write patches for open bug/feature issues, preferably with test cases included

There are a few guidelines that I need contributors to follow so that I have a chance of keeping on top of things.

Getting Started

  • Make sure you have a GitHub account.
  • Submit an issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository on GitHub.

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the main branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on main; git branch main/my_contribution main then checkout the new branch with git checkout main/my_contribution. Better avoid working directly on the main branch, to avoid conflicts if you pull in updates from origin.
  • Make commits of logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Use descriptive commit messages and reference the #issue number.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository