This repository has been archived by the owner on Jan 6, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 243
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(revamp): revamp the entire lib (backward compatible) (#63)
**What**: This uses my generator to update everything about this project **Why**: It's got updated tools and improved docs. **How**: `yo kcd-oss` :)
- Loading branch information
Kent C. Dodds
authored
Mar 4, 2017
1 parent
e33a85c
commit dad00c4
Showing
33 changed files
with
6,436 additions
and
392 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
{ | ||
"projectName": "cross-env", | ||
"projectOwner": "kentcdodds", | ||
"files": [ | ||
"README.md" | ||
], | ||
"imageSize": 100, | ||
"commit": false, | ||
"contributors": [ | ||
{ | ||
"login": "kentcdodds", | ||
"name": "Kent C. Dodds", | ||
"avatar_url": "https://avatars.githubusercontent.com/u/1500684?v=3", | ||
"profile": "https://kentcdodds.com", | ||
"contributions": [ | ||
"code", | ||
"doc", | ||
"infra", | ||
"test" | ||
] | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{ | ||
"presets": [ | ||
["env", { | ||
"targets": { | ||
"node": 4 | ||
} | ||
}], | ||
"stage-2" | ||
] | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,3 @@ | ||
node_modules | ||
coverage | ||
dist | ||
local-examples | ||
other |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<!-- | ||
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted! | ||
Please make sure that you are familiar with and follow the Code of Conduct for | ||
this project (found in the CODE_OF_CONDUCT.md file). | ||
Please fill out this template with all the relevant information so we can | ||
understand what's going on and fix the issue. | ||
I'll probably ask you to submit the fix (after giving some direction). If you've | ||
never done that before, that's great! Check this free short video tutorial to | ||
learn how: http://kcd.im/pull-request | ||
--> | ||
|
||
- `cross-env` version: | ||
- `node` version: | ||
- `npm` (or `yarn`) version: | ||
|
||
Relevant code or config | ||
|
||
```javascript | ||
|
||
``` | ||
|
||
What you did: | ||
|
||
|
||
|
||
What happened: | ||
|
||
<!-- Please provide the full error message/screenshots/anything --> | ||
|
||
Reproduction repository: | ||
|
||
<!-- | ||
If possible, please create a repository that reproduces the issue with the | ||
minimal amount of code possible. | ||
--> | ||
|
||
Problem description: | ||
|
||
|
||
|
||
Suggested solution: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<!-- | ||
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted! | ||
Please make sure that you are familiar with and follow the Code of Conduct for | ||
this project (found in the CODE_OF_CONDUCT.md file). | ||
Also, please make sure you're familiar with and follow the instructions in the | ||
contributing guidelines (found in the CONTRIBUTING.md file). | ||
If you're new to contributing to open source projects, you might find this free | ||
video course helpful: http://kcd.im/pull-request | ||
Please fill out the information below to expedite the review and (hopefully) | ||
merge of your pull request! | ||
--> | ||
|
||
<!-- What changes are being made? (What feature/bug is being fixed here?) --> | ||
**What**: | ||
|
||
<!-- Why are these changes necessary? --> | ||
**Why**: | ||
|
||
<!-- How were these changes implemented? --> | ||
**How**: | ||
|
||
|
||
<!-- feel free to add additional comments --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,6 @@ | ||
.idea | ||
*.log | ||
*.iml | ||
*.DS_Store | ||
|
||
node_modules | ||
coverage | ||
nohup.out | ||
dist | ||
.opt-in | ||
.opt-out | ||
|
||
*.ignored.* | ||
*.ignored/ | ||
*.ignored |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
registry=http://registry.npmjs.org/ | ||
save-exact=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# CHANGELOG | ||
|
||
The changelog is automatically updated using [semantic-release](https://github.com/semantic-release/semantic-release). | ||
You can see it on the [releases page](../releases). |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Contributing | ||
|
||
Thanks for being willing to contribute! | ||
|
||
**Working on your first Pull Request?** You can learn how from this *free* series | ||
[How to Contribute to an Open Source Project on GitHub][egghead] | ||
|
||
## Project setup | ||
|
||
1. Fork and clone the repo | ||
2. `$ npm install` to install dependencies | ||
3. `$ npm start validate` to validate you've got it working | ||
4. Create a branch for your PR | ||
|
||
This project uses [`p-s`][p-s] and you can run `npm start` to see what scripts are available. | ||
|
||
## Add yourself as a contributor | ||
|
||
This project follows the [all contributors][all-contributors] specification. To add yourself to the table of | ||
contributors on the README.md, please use the automated script as part of your PR: | ||
|
||
```console | ||
npm start addContributor <YOUR_GITHUB_USERNAME> | ||
``` | ||
|
||
Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run | ||
it again and select the added contribution type. | ||
|
||
## Committing and Pushing changes | ||
|
||
This project uses [`semantic-release`][semantic-release] to do automatic releases and generate a changelog based on the | ||
commit history. So we follow [a convention][convention] for commit messages. Please follow this convention for your | ||
commit messages. | ||
|
||
You can use `commitizen` to help you to follow [the convention][convention] | ||
|
||
Once you are ready to commit the changes, please use the below commands | ||
|
||
1. `git add <files to be comitted>` | ||
2. `$ npm start commit` | ||
|
||
... and follow the instruction of the interactive prompt. | ||
|
||
### opt into git hooks | ||
|
||
There are git hooks set up with this project that are automatically installed when you install dependencies. They're | ||
really handy, but are turned off by default (so as to not hinder new contributors). You can opt into these by creating | ||
a file called `.opt-in` at the root of the project and putting this inside: | ||
|
||
``` | ||
commit-msg | ||
pre-commit | ||
``` | ||
|
||
## Help needed | ||
|
||
Please checkout the [ROADMAP.md][ROADMAP] and raise an issue to discuss | ||
any of the items in the want to do or might do list. | ||
|
||
Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks! | ||
|
||
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github | ||
[semantic-release]: https://npmjs.com/package/semantic-release | ||
[convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md | ||
[all-contributors]: https://github.com/kentcdodds/all-contributors | ||
[ROADMAP]: ./other/ROADMAP.md | ||
[p-s]: https://npmjs.com/package/p-s |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.