Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.76 KB

contributing.md

File metadata and controls

32 lines (21 loc) · 1.76 KB
Raw

Feature requests

Add 👍 reaction to issues for features you would like to see added to Zdog. Do not add +1 comments — they will be deleted.

Reduced test cases required

All bug reports and problem issues require a reduced test case. Create one by forking this any one of the Zdog demos on CodePen.

CodePen

Test cases

  • A reduced test case clearly demonstrates the bug or issue.
  • It contains the bare minimum HTML, CSS, and JavaScript required to demonstrate the bug.
  • A link to your production site is not a reduced test case.

Providing a reduced test case is the best way to get your issue addressed. They help you point out the problem. They help me verify and debug the problem. They help others understand the problem. Without a reduced test case, your issue may be closed.

Pull requests

Contributions are welcome!

  • For typos and one-line fixes, send those right in.
  • For larger features, open an issue before starting any significant work. Let's discuss to see how your feature fits within Zdog's vision.
  • Follow the code style. Spaces in brackets, semicolons, trailing commas.
  • Do not edit dist/ files. Make your edits to source files in js/ and css/.
  • Do not run make to update dist/ files. I'll take care of this when I create a new release.