Skip to content

Commit d40057a

Browse files
committed
Add readme, changelog and contributing docs
1 parent 41698ab commit d40057a

3 files changed

Lines changed: 76 additions & 0 deletions

File tree

Changelog.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
4+
5+
## 1.0.0 (2020-04-19)
6+
7+
- Made task create webpack.config.js, index.html and src/index.html
8+
- Made task install required dependencies
9+
- Made task add scripts to `package.json`

Contributing.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# How to contribute
2+
3+
I love pull requests. And following this guidelines will make your pull request easier to merge.
4+
5+
## Prerequisites
6+
7+
- Install dependencies: `yarn`.
8+
9+
## Development workflow
10+
11+
1. Clone this repository into ~/dotfiles/mrm/webpack/
12+
2. Create a new branch
13+
3. Create a sandbox directory to test
14+
4. `cd` into the sandbox directory and run `mrm webpack`
15+
5. Make changes to the mrm task
16+
6. Wipe the sandbox directory and run `mrm webpack`
17+
7. See your changes
18+
19+
## Other notes
20+
21+
- I'm using [Prettier](https://github.com/prettier/prettier) to format code, so don’t worry much about code formatting.
22+
- Don’t commit generated files, like minified JavaScript.
23+
- Don’t change version number and changelog.
24+
25+
## Need help?
26+
27+
If you want to contribute but have any questions, concerns or doubts, feel free to ping maintainers. Ideally create a pull request with `WIP` (Work in progress) in its title and ask questions in the pull request description.

Readme.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# mrm-task-webpack
2+
3+
[mrm](https://github.com/sapegin/mrm) task that adds basic [webpack](https://webpack.js.org/) configuration and yarn scripts.
4+
5+
This should allow you to do `yarn start:dev` immediately after running `mrm webpack`.
6+
7+
## What it does
8+
9+
- Installs dependencies
10+
- Adds yarn scripts to run Webpack and DevServer
11+
- Creates webpack.config.js, index.html, and src/index.js if they don't exist
12+
13+
## Usage
14+
15+
```bash
16+
yarn global add mrm mrm-task-webpack
17+
mrm webpack
18+
```
19+
20+
### Scripts
21+
22+
```bash
23+
yarn start:dev # starts webpack dev server
24+
yarn build:dev # builds webpack in development mode
25+
yarn build # builds webpack in production mode
26+
```
27+
28+
## Changelog
29+
30+
The changelog can be found in [changelog](Changelog.md).
31+
32+
## Contributing
33+
34+
Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](Contributing.md).
35+
36+
## Authors and license
37+
38+
[Victor Chan](https://vctr.dev) and [contributors](https://github.com/victorzchan/mrm-task-webpack/graphs/contributors).
39+
40+
MIT License, see the included [License.md](License.md) file.

0 commit comments

Comments
 (0)