Skip to content

Commit

Permalink
fix(templates): add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Simon Finney committed Mar 28, 2018
1 parent afaf71c commit e88cf12
Show file tree
Hide file tree
Showing 7 changed files with 193 additions and 101 deletions.
6 changes: 4 additions & 2 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
{
"extends": ["airbnb-base", "prettier"],
"parser": "babel-eslint",
"extends": ["eslint:recommended", "prettier"],
"env": {
"browser": true
"browser": true,
"node": true
}
}
39 changes: 39 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## {{ short description }}

### Expected behaviour

{{ expected behaviour }}

### Actual behaviour

{{ actual behaviour }}

### Steps for reproducing the behaviour

1. {{ step 1 }}
2. {{ step 2 }}
3. {{ step 3 }}

### Screenshots

#### {{ Step 1 }}

![Step 1 screenshot]({{ url }})

#### {{ Step 2 }}

![Step 2 screenshot]({{ url }})

#### {{ Step 3 }}

![Step 3 screenshot]({{ url }})

### Affected browsers

[UserAgents.com](http://www.whatsmyua.com/)

* [ ] {{ affected browser }}

### Optional information

**Version -** {{ version }}
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Fixes #{{ issue number }}

## Proposed changes

Changes proposed in this pull request:

* {{ change 1 }}
* {{ change 2 }}
* {{ change 3 }}

## Testing instructions

* {{ instruction 1 }}
* {{ instruction 2 }}
* {{ instruction 3 }}

@SimonFinney
7 changes: 6 additions & 1 deletion .lintstagedrc
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
{ "*.js": "yarn test" }
{
"*.js": [
"yarn format",
"yarn test"
]
}
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ Parallax effect using custom properties - Inspired by [Cheapass Parallax - daver
## Installation

```bash
# npm
npm install custom-properties-parallax --save

# Or, with Yarn
# Yarn
yarn add custom-properties-parallax
```

Expand Down
19 changes: 12 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,31 @@
"prepublishOnly": "yarn build",
"semantic-release": "semantic-release",
"start": "webpack-dev-server --env.development --mode development --open",
"test": "yarn format && yarn lint",
"travis-deploy-once": "travis-deploy-once"
"test": "yarn lint"
},
"repository": {
"type": "git",
"url": "https://github.com/SimonFinney/custom-properties-parallax.git"
},
"keywords": ["css", "custom", "properties", "parallax"],
"keywords": [
"css",
"custom",
"properties",
"parallax"
],
"author": "Simon Finney <[email protected]>",
"license": "MIT",
"bugs": {
"url": "https://github.com/SimonFinney/custom-properties-parallax/issues"
},
"homepage":
"https://github.com/SimonFinney/custom-properties-parallax#readme",
"homepage": "https://github.com/SimonFinney/custom-properties-parallax#readme",
"devDependencies": {
"@babel/preset-env": "^7.0.0-beta.42",
"@commitlint/cli": "^6.1.3",
"@commitlint/config-conventional": "^6.1.3",
"babel-eslint": "^8.2.2",
"clean-webpack-plugin": "^0.1.19",
"eslint": "^4.19.0",
"eslint-config-airbnb-base": "^12.1.0",
"eslint-config-prettier": "^2.9.0",
"eslint-plugin-import": "^2.9.0",
"html-webpack-plugin": "^3.0.7",
Expand All @@ -46,5 +49,7 @@
"webpack-dev-server": "^3.1.1"
},
"dependencies": {},
"files": ["dist"]
"files": [
"dist"
]
}
Loading

0 comments on commit e88cf12

Please sign in to comment.