Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/update contributor and readme #185

Merged
merged 3 commits into from
Dec 21, 2016
Merged

Feature/update contributor and readme #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2451cdf
docs(setup): Add new setup steps with yarn
Dec 4, 2016
82e5b1d
docs(commit): Add explicit message for good commit messages
Dec 4, 2016
c4035d4
docs: Add note abuout rewrite in README
Dec 9, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,29 @@ the [webpack Gitter][webpackgitter] and include both your webpack, karma & karma
**If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.**

### Setup
You can decide wether you want to use yarn or npm to setup karma-webpack. Below you will find the setup instructions of both.

#### Using Yarn
```bash
git clone https://github.com/webpack/karma-webpack.git
cd karma-webpack
npm install
npm install -g yarn
yarn install
yarn link
yarn link webpack
```

To run the entire test suite use:

```bash
yarn test
```

#### Using npm
```bash
git clone https://github.com/webpack/karma-webpack.git
cd karma-webpack
npm i
```

To run the entire test suite use:
Expand All @@ -29,6 +47,7 @@ To run the entire test suite use:
npm test
```


### Submitting Changes

After getting some feedback, push to your fork and submit a pull request. We
Expand All @@ -39,6 +58,7 @@ Some things that will increase the chance that your pull request is accepted:

* Write tests
* Follow the existing Webpack coding style defined in the eslint and editor config rules.
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)

### Required `global` npm packages
We use [conventional changelog][conventionalchangelog] & the [commitizen][cz] adapter to generate our release notes using Angular's commit message convention.
Expand Down Expand Up @@ -113,4 +133,4 @@ A detailed explanation can be found in this [google document][google-commit].
[webpackgitter]: https://gitter.im/webpack/webpack
[conventionalchangelog]: https://github.com/conventional-changelog/conventional-changelog
[cz]: https://github.com/commitizen/cz-cli
[google-commit]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/preview
[google-commit]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/preview
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
</a>
<h1>Karma Webpack</h1>
<p>Use webpack to preprocess files in karma<p>
<p><b>Note:</b> At the moment we are doing a complete rewrite of karma-webpack. The code behind the current version is on the branch [v1](https://github.com/webpack/karma-webpack/tree/v1) in this repo. We will continue maintaining it in the mean time. This means, if you are willing to open a pull request for the version 1, double check that when you open the PR, the target branch is v1 instead of master.</p>
</div>

<h2 align="center">Install</h2>
Expand Down Expand Up @@ -266,4 +267,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
THE SOFTWARE.