Skip to content

Commit 669c3c8

Browse files
author
Kent C. Dodds
committed
feat(lib): Initial commit ✨
0 parents  commit 669c3c8

24 files changed

+944
-0
lines changed

.babelrc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"presets": ["es2015", "stage-2"],
3+
"env": {
4+
"test": {
5+
"plugins": ["rewire"]
6+
}
7+
}
8+
}

.eslintignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
.nyc_output
3+
coverage
4+
dist

.github/ISSUE_TEMPLATE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--
2+
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
3+
4+
Please fill out this template with all the relevant information so we can understand what's going on and fix the issue.
5+
6+
I'll probably ask you to submit the fix (after giving some direction). If you've never done that before, that's great!
7+
Check this free short video tutorial to learn how: http://kcd.im/pull-request
8+
-->
9+
10+
- `p-s` version:
11+
- `node` version:
12+
- `npm` version:
13+
14+
Scripts file (or at least the relevant bits):
15+
16+
```javascript
17+
18+
```
19+
20+
The command executed:
21+
22+
```console
23+
24+
```
25+
26+
The output:
27+
28+
```console
29+
30+
```
31+
32+
Problem description:
33+
34+
35+
36+
Suggested solution:

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
.nyc_output
3+
coverage
4+
dist
5+
.opt-in
6+
.opt-out

.travis.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
sudo: false
2+
language: node_js
3+
cache:
4+
directories:
5+
- node_modules
6+
notifications:
7+
email: false
8+
node_js:
9+
- '4'
10+
- '0.12'
11+
- '0.10'
12+
before_install:
13+
- npm i -g npm@^3.0.0
14+
before_script:
15+
- npm prune
16+
script:
17+
- npm run validate
18+
after_success:
19+
- 'curl -Lo travis_after_all.py https://git.io/travis_after_all'
20+
- python travis_after_all.py
21+
- export $(cat .to_export_back) &> /dev/null
22+
- npm start report-coverage
23+
- npm run release
24+
branches:
25+
except:
26+
- /^v\d+\.\d+\.\d+$/

CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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. `$ npm install` to install dependencies
12+
3. `$ npm start validate` to validate you've got it working
13+
4. Create a branch for your PR
14+
15+
## Committing and Pushing changes
16+
17+
This project uses (or soon will) [`semantic-release`](http://npm.im/semantic-release)
18+
to do automatic releases and generate a changelog based on the commit history. So we
19+
follow [a convention](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md)
20+
for commit messages. Please follow this convention for your commit messages.
21+
22+
You can use `commitizen` to help you to follow [the convention](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md)
23+
24+
Once you are ready to commit the changes, please use the below commands
25+
26+
1. `git add <files to be comitted>`
27+
2. `$ npm run commit`
28+
29+
... and follow the instruction of the interactive prompt.
30+
31+
## Help needed
32+
33+
Please checkout the [ROADMAP.md](https://github.com/kentcdodds/p-s/blob/master/ROADMAP.md) and raise an issue to discuss
34+
any of the items in the want to do or might do list.
35+
36+
Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!

LICENSE

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

0 commit comments

Comments
 (0)