Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.52 KB

Contributing to Sheepshead Online

The following guidelines are designed for contributors to Sheepshead Online.

Reporting Issues and Questions

For reporting a bug, a failed function or requesting a new feature, open an issue in GitHub's issue tracker. First, seach through existing issues (open or closed) that might have the answer to your question.

When reporting a bug, it is most helpful to include:

  • A quick background/summary
  • Specific steps to reproduce
  • The expected result
  • The actual result
  • Notes (i.e. why you think this might be happening)

Contributing Code

To make contributions to Sheepshead Online, request your changes or contributions via a pull request against the development branch.

Please use the following steps:

  1. Fork the sheepshead-online repository to your GitHub account.
  2. Clone your fork locally with git clone.
  3. Switch to the development branch with git checkout develop
  4. Create a new branch with a name that describes your contribution. For example, if your contribution is a bug fix to the routing, your new branch can be named bugfix/routing. You can create and switch to it with git checkout -b bugfix/routing.
  5. Make your changes on this new branch.
  6. Push your changes to your fork.
  7. Create a pull request against the develop branch of Sheepshead Online.

License

By contributing, you agree that your contributions will be licensed under the GNU AGPLv3.