Skip to content

Commit

Permalink
style: update prettier and apply on whole codebase
Browse files Browse the repository at this point in the history
  • Loading branch information
Hotell committed Nov 19, 2017
1 parent 3e22109 commit 9b13004
Show file tree
Hide file tree
Showing 14 changed files with 162 additions and 131 deletions.
15 changes: 8 additions & 7 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
## Bug report

*Delete this section if this is a feature request.*
_Delete this section if this is a feature request._

- Skate version: *x.x.x*
- Affected browsers (and versions): *IE 10*
* Skate version: _x.x.x_
* Affected browsers (and versions): _IE 10_

### Current behaviour

You can use the [Codepen skate template](https://codepen.io/Hotell/pen/RVJamm) if you need a starting point.
You can use the [Codepen skate template](https://codepen.io/Hotell/pen/RVJamm)
if you need a starting point.

### Expected behaviour

*Please explain how you'd expect it to behave.*
_Please explain how you'd expect it to behave._

## Feature request

*Delete this section if this is a bug report.*
_Delete this section if this is a bug report._

### Use case(s)

*Explain the rationale for this feature.*
_Explain the rationale for this feature._
29 changes: 16 additions & 13 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,36 @@
*If there is a linked issue, mention it here.*
_If there is a linked issue, mention it here._

- [ ] Bug
- [ ] Feature
* [ ] Bug
* [ ] Feature

## Requirements

- [ ] Read the [contribution guidelines](https://github.com/skatejs/skatejs/blob/5.x/CONTRIBUTING.md).
- [ ] Wrote tests.
- [ ] Updated docs and upgrade instructions, if necessary.
- [ ] Updated TS definitions, if necessary.
* [ ] Read the
[contribution guidelines](https://github.com/skatejs/skatejs/blob/5.x/CONTRIBUTING.md).
* [ ] Wrote tests.
* [ ] Updated docs and upgrade instructions, if necessary.
* [ ] Updated TS definitions, if necessary.

## Rationale

*Why is this PR necessary?*
_Why is this PR necessary?_

## Implementation

*Why have you implemented it this way? Did you try any other methods?*
_Why have you implemented it this way? Did you try any other methods?_

## Open questions

*Are there any open questions about this implementation that need answers?*
_Are there any open questions about this implementation that need answers?_

## Other

*Is there anything else we should know? Delete this section if you don't need it.*
_Is there anything else we should know? Delete this section if you don't need
it._

## Tasks

*List any tasks you need to do here, if any. Delete this section if you don't need it.*
_List any tasks you need to do here, if any. Delete this section if you don't
need it._

- [ ] *Example task.*
* [ ] _Example task._
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Change Log

This project adheres to [Semantic Versioning](http://semver.org/).
Every release is documented on the Github [Releases](https://github.com/skatejs/skatejs/releases) page.
For migration instructions, see [the migration docs](docs/migrating/README.md).
This project adheres to [Semantic Versioning](http://semver.org/). Every release
is documented on the Github
[Releases](https://github.com/skatejs/skatejs/releases) page. For migration
instructions, see [the migration docs](docs/migrating/README.md).
38 changes: 19 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

## Technical overview

Skate's source is kept in `src/`. It is written using the latest ES2017 version, with Flow type definitions.
Skate's source is kept in `src/`. It is written using the latest ES2017 version,
with Flow type definitions.

When Skate is built, it is transpiled in to various distribution formats, ready for use
in the browser, on a server, or in a webpack build.
When Skate is built, it is transpiled in to various distribution formats, ready
for use in the browser, on a server, or in a webpack build.

The documentation for Skate is kept in `site/`, and is written using Skate with server-side rendering.
The documentation for Skate is kept in `site/`, and is written using Skate with
server-side rendering.

Unit tests exist both for the source and for the documentation examples.

Expand All @@ -17,33 +19,31 @@ Skate uses `npm` as its package manager. Ensure you're on `npm@5` at a minimum.

Here are the main commands you'll need while developing:

- Creating a bundle: `npm prepublish`
- Developing with tests: `npm run test:watch`
- Fixing js and ts code style: `npm run style:fix`
- Commiting (with commitizen): `npm run commit`
* Creating a bundle: `npm prepublish`
* Developing with tests: `npm run test:watch`
* Updating skate site: `npm run dev`
* Fixing whole project code format via prettier: `npm run format`
* Updating Typescript definitions ( if you've changed anything make sure all TS
test pass ): `npm run test:ts`

## Making a change

All changes to Skate should be include an accompanying test case to demonstrate the feature or bug being addressed.
All changes to Skate should be include an accompanying test case to demonstrate
the feature or bug being addressed.

## Committing

We are using semantic-release and conventional-changelog for releasing, so our commit messages have to follow strict rules.

The commit message formatting can be added using a typical git workflow or through the use of a CLI wizard ([Commitizen](https://github.com/commitizen/cz-cli)).

To use the wizard, run `npm run commit` in your terminal after staging your changes in git.

A detailed explanation can be found in this [document](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#).
// @TODO

## Pull Requests

Pull requests should be issued for even the smallest change. Every pull request should have at least one corresponding issue.
Pull requests should be issued for even the smallest change. Every pull request
should have at least one corresponding issue.

## Releasing

Skate uses semantic-release and conventional-changelog so releases are published automatically.
// @TODO

## Notes

- Default branch should always be the latest stable branch.
* Default branch should always be the latest stable branch.
Loading

0 comments on commit 9b13004

Please sign in to comment.