Skip to content
This repository was archived by the owner on Feb 24, 2023. It is now read-only.

Commit ebde022

Browse files
CONTRIBUTING file and README fixes
1 parent 08c3081 commit ebde022

File tree

2 files changed

+33
-18
lines changed

2 files changed

+33
-18
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Contributing
2+
3+
🤝 Thanks to [Maciej Wach](https://github.com/wachu91) for inventing the name and to all [Contributors](https://github.com/lukaszflorczak/vue-agile/graphs/contributors) for your development.
4+
5+
### Pull requests
6+
If you would like ot fix a bug or create a new feature, be sure:
7+
8+
1. You created a pull request to a proper branch (`master` branch for bug fixes, `develop` branch for features).
9+
2. You put a description about what your code changes.
10+
3. You used [keywords](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) to mark related issues in your pull request.
11+
4. You updated the documentation (README file).
12+
13+
### Issues
14+
If you want just request a bug or new feature just use a proper issue template. Describe your expectations as accurately as possible and add a demo from CodePen.
15+
16+
### Commands
17+
18+
```bash
19+
# project setup
20+
yarn install
21+
22+
# compiles and hot-reloads for development
23+
yarn serve
24+
25+
# compiles and minifies for production
26+
yarn build-bundle
27+
28+
# lint and fixes files
29+
yarn lint --fix
30+
31+
# runs unit tests
32+
yarn test:unit
33+
```

README.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -366,25 +366,7 @@ You can also check [nuxt-agile](https://github.com/lukaszflorczak/nuxt-agile) re
366366

367367
If content changes, you have to use `reload` or in some cases, you can use `key` property: `<agile :key="mySlides.length">...</agile>` (it'll rebuild the carousel after each change of `mySlides` length).
368368

369-
370369
#### 2. Support for IE11
371370

372371
Yes, the UMD bundle is built with support for IE11. If you build your app with vue-agile as a dependency yourself be sure you configured babel properly (read more in [vue documentation](https://cli.vuejs.org/guide/browser-compatibility.html#browserslist) or just use my config for [babel](https://github.com/lukaszflorczak/vue-agile/blob/master/babel.config.js)).
373372

374-
## Contributing
375-
376-
🤝 Thanks to [Maciej Wach](https://github.com/wachu91) for inventing the name and to all [Contributors](https://github.com/lukaszflorczak/vue-agile/graphs/contributors) for your development.
377-
378-
```bash
379-
# project setup
380-
yarn install
381-
382-
# compiles and hot-reloads for development
383-
yarn serve
384-
385-
# compiles and minifies for production
386-
yarn build-bundle
387-
388-
# lint and fixes files
389-
yarn run lint
390-
```

0 commit comments

Comments
 (0)