+25

.github/contributing.md

reviewed

··· 1 1 + ## Feature requests 2 2 + 3 3 + **Add 👍 reaction** to issues for features you would like to see added to Zdog. Do not add +1 comments — [they will be deleted](https://metafizzy.co/blog/use-github-reactions-delete-plus-1-comments/). 4 4 + 5 5 + ## Submitting issues 6 6 + 7 7 + ### Reduced test case required 8 8 + 9 9 + All bug reports and problem issues require a [**reduced test case**](https://css-tricks.com/reduced-test-cases/). 10 10 + 11 11 + + A reduced test case clearly demonstrates the bug or issue. 12 12 + + It contains the bare minimum HTML, CSS, and JavaScript required to demonstrate the bug. 13 13 + + A link to your production site is **not** a reduced test case. 14 14 + 15 15 + 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. 16 16 + 17 17 + ## Pull requests 18 18 + 19 19 + Contributions are welcome! 20 20 + 21 21 + + **For typos and one-line fixes,** send those right in. 22 22 + + **For larger features,** open an issue before starting any significant work. Let's discuss to see how your feature fits within Flickity's vision. 23 23 + + **Follow the code style.** Spaces in brackets, semicolons, trailing commas. 24 24 + + **Do not edit `dist/` files.** Make your edits to source files in `js/` and `css/`. 25 25 + + **Do not run `make` to update `dist/` files.** I'll take care of this when I create a new release.

+3

.github/issue_template.md

reviewed

··· 1 1 + <!-- Thanks for submitting an issue! If you have a bug or problem issue, please include a **reduced test case**. Create one in CodePen or other demo site. See guidelines link above. --> 2 2 + 3 3 + **Test case:** https://codepen.io/desandro/pen/azqbop

+9 -4

README.md

reviewed

··· 8 8 9 9 ### Download 10 10 11 11 - + [zdog.pkgd.min.js](https://unpkg.com/zdog@0/dist/zdog.pkgd.min.js) minified, or 12 12 - + [zdog.pkgd.js](https://unpkg.com/zdog@0/dist/zdog.pkgd.min.js) un-minified 11 11 + + [zdog.dist.min.js](https://unpkg.com/zdog@0/dist/zdog.dist.min.js) minified, or 12 12 + + [zdog.dist.js](https://unpkg.com/zdog@0/dist/zdog.dist.js) un-minified 13 13 14 14 ### CDN 15 15 16 16 Link directly to Zdog JS on [unpkg](https://unpkg.com). 17 17 18 18 ``` html 19 19 - <script src="https://unpkg.com/zdog@0/dist/zdog.pkgd.min.js"></script> 19 19 + <script src="https://unpkg.com/zdog@0/dist/zdog.dist.min.js"></script> 20 20 ``` 21 21 22 22 ### Package managers ··· 84 84 85 85 Zdog v1 is a beta-release, of sorts. This is my first time creating a 3D engine, so I probably got some stuff wrong. Expect lots of changes for v2. Provide input and select new features on the [Zdog issue tracker on GitHub](https://github.com/metafizzy/zdog/issues). 86 86 87 87 + ### Other Zdog repos 88 88 + 89 89 + + [zdog-demos](https://github.com/metafizzy/zdog-demos) - Lots more bigger, wilder Zdog demos 90 90 + + [zdog-docs](https://github.com/metafizzy/zdog-docs) - Documentation site source code for [zzz.dog](https://zzz.dog) 91 91 + 87 92 --- 88 93 89 89 - Licensed MIT 94 94 + Licensed MIT. Made by Metafizzy 🌈🐻