Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.68 KB

Contributing Guidelines

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Snappier. These are just guidelines, not rules, so use your best judgement and feel free to propose changes to this document in a pull request.

Getting Started

Snappier is built with C#. If you are new to C#, please head here!

Community

  • If you have any questions regarding Snappier, open an issue.

Issues

Ensure the bug was not already reported by searching on GitHub under issues. If you're unable to find an open issue addressing the bug, open a new issue.

Please pay attention to the following points while opening an issue.

Write detailed information

Detailed information is very helpful to understand an issue.

For example:

  • How to reproduce the issue, step-by-step.
  • The expected behavior (or what is wrong).
  • Error messages and stack traces, if applicable.
  • If possible, sample files that produce the error.

Pull Requests

Pull Requests are always welcome.

  1. When you edit the code, please make sure everything is building and any and all tests succeed.
  2. If new behaviors are added, tests should be added to prevent regressions in the future.
  3. Ensure the PR description clearly describes the problem and solution. It should include:
    • An imperative first line.
    • Motivation for the change.
    • If warranted, and explanation of why the given solution was chosen.
    • The relevant issue number, if applicable.