Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.02 KB

Legal

By submitting a pull request, you represent that you have the right to license your contribution to Eric Lewis and the community, and agree by submitting the patch that your contributions are licensed under the MIT license (see LICENSE.md).

How to submit a bug report

Please ensure to specify the following:

  • PageSheet commit hash
  • Contextual information (e.g. what you were trying to achieve with PageSheet)
  • Simplest possible steps to reproduce
    • More complex the steps are, lower the priority will be.
    • Small project that reproduces the issue.
  • Anything that might be relevant in your opinion, such as:
    • Swift version or Xcode version
    • iOS version and Build Configuration
    • Stack Trace or Sentry output

Writing a Patch

A good PageSheet patch is:

  1. Concise, and contains as few changes as needed to achieve the end result.
  2. Tested, ensuring that any tests provided failed before the patch and pass after it.
  3. Documented, adding API documentation as needed to cover new functions and properties.