Skip to content

Commit 66c709a

Browse files
mattphillipsmattphillips
committed
Bootstrap project with oss-box
1 parent 4c378f3 commit 66c709a

11 files changed

+221
-0
lines changed

‎.all-contributorsrc

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"projectName": "jest-expect-message",
3+
"projectOwner": "mattphillips",
4+
"files": [
5+
"README.md"
6+
],
7+
"imageSize": 100,
8+
"commit": false,
9+
"contributors": []
10+
}

‎.github/ISSUE_TEMPLATE.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!--
2+
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
3+
4+
If you are raising a bug uncomment the next section and fill in the relevant information.
5+
6+
If you would like to request a feature then uncomment the last section :)
7+
-->
8+
9+
<!--
10+
**Bug**
11+
12+
- `package` version:
13+
- `node` version:
14+
- `npm` (or `yarn`) version:
15+
16+
Relevant code or config
17+
18+
```javascript
19+
20+
```
21+
22+
What you did:
23+
24+
What happened (please provide anything you think will help):
25+
26+
Reproduction repository (if possible):
27+
28+
-->
29+
30+
<!--
31+
**Feature Request**
32+
33+
Description:
34+
35+
Possible solution:
36+
37+
-->

‎.github/PULL_REQUEST_TEMPLATE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!--
2+
Thanks for spending the time to send this PR :D.
3+
4+
Please fill out the information below and make sure you're familiar
5+
with the contributing guidelines (found in the CONTRIBUTING.md file).
6+
-->
7+
8+
<!-- What changes are being made? (feature/bug) -->
9+
### What
10+
11+
<!-- Why are these changes necessary? Link any related issues -->
12+
### Why
13+
14+
<!-- If necessary add any additional notes on the implementation -->
15+
### Notes
16+
17+
### Housekeeping
18+
19+
- [ ] Unit tests
20+
- [ ] Documentation is up to date
21+
- [ ] No additional lint warnings

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules
2+
dist
3+
.DS_Store
4+
*.log
5+
coverage

‎.travis.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
language: node_js
2+
node_js:
3+
- '8'
4+
- '6'
5+
cache:
6+
directories:
7+
- node_modules
8+
script: 'yarn test:coverage'
9+
after_success: 'yarn test:report'

‎CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing
2+
3+
Thanks for being willing to contribute!
4+
5+
**Working on your first Pull Request?** You can learn how from this *free* series
6+
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
7+
8+
## Project setup
9+
10+
1. Fork and clone the repo
11+
2. `$ yarn install` to install dependencies
12+
3. `$ yarn test` to validate you've got it working
13+
4. Create a branch for your PR
14+
15+
## Making changes
16+
17+
- All changes should have unit tests
18+
- Any relevant documentation should be updated
19+
- No linting warnings/errors should be introduced
20+
21+
## Committing and Pushing changes
22+
23+
Once you are ready to commit the changes, please use the below commands
24+
25+
1. `git add <files to be comitted>`
26+
2. `git commit -m 'A meaningful message`
27+
28+
*Note: please use present tense in commit messages i.e. `Add feature X` and not ~`Added feature X`~*
29+
30+
## Add yourself as a contributor
31+
32+
This project follows the [all contributors](https://github.com/kentcdodds/all-contributors)
33+
specification. To add yourself to the table of contributors on the README.md, please use
34+
the automated script as part of your PR:
35+
36+
```console
37+
yarn contributor <YOUR_GITHUB_USERNAME>
38+
```
39+
40+
Follow the prompt. If you've already added yourself to the list and are making a
41+
new type of contribution, you can run it again and select the added contribution
42+
type. If you need to edit the `.all-contributorsrc` file by hand that's fine
43+
too, just run `yarn contributor:generate` to regenerate the table
44+
45+
## Help needed
46+
47+
Please checkout the [ROADMAP](docs/ROADMAP.md) and raise an issue to discuss
48+
any of the items

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018-present Matt Phillips <[email protected]> mattphillips.io
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<div align="center">
2+
<h1>jest-expect-message</h1>
3+
4+
Add custom message to Jest expects
5+
</div>
6+
7+
<hr />
8+
9+
[![Build Status](https://img.shields.io/travis/mattphillips/jest-expect-message.svg?style=flat-square)](https://travis-ci.org/mattphillips/jest-expect-message)
10+
[![Code Coverage](https://img.shields.io/codecov/c/github/mattphillips/jest-expect-message.svg?style=flat-square)](https://codecov.io/github/mattphillips/jest-expect-message)
11+
[![version](https://img.shields.io/npm/v/jest-expect-message.svg?style=flat-square)](https://www.npmjs.com/package/jest-expect-message)
12+
[![downloads](https://img.shields.io/npm/dm/jest-expect-message.svg?style=flat-square)](http://npm-stat.com/charts.html?package=jest-expect-message&from=2017-09-14)
13+
[![MIT License](https://img.shields.io/npm/l/jest-expect-message.svg?style=flat-square)](https://github.com/mattphillips/jest-expect-message/blob/master/LICENSE)
14+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
15+
[![Roadmap](https://img.shields.io/badge/%F0%9F%93%94-roadmap-CD9523.svg?style=flat-square)](https://github.com/mattphillips/jest-expect-message/blob/master/docs/ROADMAP.md)
16+
[![Examples](https://img.shields.io/badge/%F0%9F%92%A1-examples-ff615b.svg?style=flat-square)](https://github.com/mattphillips/jest-expect-message/blob/master/docs/EXAMPLES.md)
17+
## Problem
18+
19+
## Solution
20+
21+
## Installation
22+
23+
With npm:
24+
```sh
25+
npm install --save-dev jest-expect-message
26+
```
27+
28+
With yarn:
29+
```sh
30+
yarn add -D jest-expect-message
31+
```
32+
33+
## Setup
34+
35+
## Usage
36+
37+
## Contributors
38+
39+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
40+
<!-- ALL-CONTRIBUTORS-LIST:END -->
41+
42+
## LICENSE
43+
44+
[MIT](/LICENSE)
45+

‎docs/EXAMPLES.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Examples
2+
3+
☹️ None created yet, fancy adding some? See [CONTRIBUTING](/CONTRIBUTING.md)

‎docs/ROADMAP.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Project Roadmap
2+
3+
## Want something added? Feel free to open an issue :)

‎package.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "jest-expect-message",
3+
"version": "0.0.1",
4+
"description": "Add custom message to Jest expects",
5+
"main": "dist/index.js",
6+
"scripts": {
7+
},
8+
"keywords": [],
9+
"author": "Matt Phillips <[email protected]> mattphillips.io",
10+
"license": "MIT",
11+
"repository": {
12+
"type": "git",
13+
"url": "git+https://github.com/mattphillips/jest-expect-message.git"
14+
},
15+
"bugs": {
16+
"url": "https://github.com/mattphillips/jest-expect-message/issues"
17+
},
18+
"homepage": "https://github.com/mattphillips/jest-expect-message#readme"
19+
}

0 commit comments

Comments
 (0)