Skip to content

Commit

Permalink
📝 revise .github, readme, comments
Browse files Browse the repository at this point in the history
  • Loading branch information
desandro committed May 28, 2019
1 parent fe68519 commit e5da999
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 16 deletions.
11 changes: 10 additions & 1 deletion .github/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@

## Reduced test cases required

All bug reports and problem issues require a [**reduced test case**](https://css-tricks.com/reduced-test-cases/). Create one by [forking this CodePen](https://codepen.io/desandro/pen/xNLWwG).
All bug reports and problem issues require a [**reduced test case**](https://css-tricks.com/reduced-test-cases/). Create one by forking this any one of the [Zdog demos on CodePen](https://codepen.io/desandro/pens/tags/?grid_type=list&selected_tag=zdog-v1-docs&sort_col=created_at&sort_order=asc).

**CodePen**

+ [Hello world canvas](https://codepen.io/desandro/pen/YbrLaO)
+ [Hello world SVG](https://codepen.io/desandro/pen/Bewxme)
+ [resize fullscreen](https://codepen.io/desandro/pen/dEJxaV)
+ [Stutter](https://codepen.io/desandro/pen/xNPaoP)

**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.
Expand Down
4 changes: 2 additions & 2 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!-- 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. -->
<!-- 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 contributing guidelines. -->

**Test case:** https://codepen.io/desandro/pen/xNLWwG
**Test case:** https://codepen.io/desandro/pen/YbrLaO
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Create 3D models with Zdog by adding shapes. See [Getting started](https://zzz.d
``` js
let isSpinning = true;

const illo = new Zdog.Illustration({
let illo = new Zdog.Illustration({
element: '.zdog-canvas',
zoom: 4,
dragRotate: true,
Expand Down Expand Up @@ -86,7 +86,7 @@ Zdog v1 is a beta-release, of sorts. This is my first time creating a 3D engine,

### Other Zdog repos

+ [zdog-demos](https://github.com/metafizzy/zdog-demos) - More, bigger, wilder Zdog demos
+ [zdog-demos](https://github.com/metafizzy/zdog-demos) - Bigger, wilder Zdog demos
+ [zdog-docs](https://github.com/metafizzy/zdog-docs) - Documentation site source code for [zzz.dog](https://zzz.dog)

---
Expand Down
10 changes: 4 additions & 6 deletions demos/hemisphere-cone-ball/hemisphere-cone-ball.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ var orange = '#E62';
var garnet = '#C25';
var eggplant = '#636';

// -- illustration shapes --- //
// ----- model ----- //

var hemi = new Zdog.Hemisphere({
addTo: illo,
Expand Down Expand Up @@ -68,7 +68,7 @@ var colorWheel = [ eggplant, garnet, orange, gold, yellow, ];
}
});

// -- animate --- //
// ----- animate ----- //

var keyframes = [
{ x: TAU * 0, y: TAU * 0 },
Expand All @@ -86,10 +86,6 @@ function animate() {
requestAnimationFrame( animate );
}

animate();

// -- update -- //

function spin() {
if ( !isSpinning ) {
return;
Expand All @@ -104,3 +100,5 @@ function spin() {
illo.rotate.y = Zdog.lerp( keyA.y, keyB.y, tween ) ;
ticker++;
}

animate();
6 changes: 3 additions & 3 deletions demos/kid-kit/kid-kit.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// --- variables --- //
// ----- setup ----- //

var offWhite = '#FED';
var gold = '#EA0';
Expand All @@ -11,7 +11,7 @@ var illo = new Zdog.Illustration({
dragRotate: true,
});

// --- model --- //
// ----- model ----- //

// body center
new Zdog.Shape({
Expand Down Expand Up @@ -294,7 +294,7 @@ cloakSide.copyGraph({
});


// -- animate --- //
// ----- animate ----- //

function animate() {
illo.updateRenderGraph();
Expand Down
2 changes: 1 addition & 1 deletion demos/shade-and-shades/shade-and-shades.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ var illo = new Zdog.Illustration({
},
});

// -- illustration shapes --- //
// ----- model ----- //

// cap top
[ 0, 1, 2, 3, 4 ].forEach( function( i ) {
Expand Down
2 changes: 1 addition & 1 deletion demos/solids/solids.js
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ solids.push( cube );

})();

// -- animate --- //
// ----- animate ----- //

var keyframes = [
{ x: 0, y: 0 },
Expand Down

0 comments on commit e5da999

Please sign in to comment.