Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit ad78fe3
Showing
43 changed files
with
14,587 additions
and
0 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,22 @@ | ||
{ | ||
"projectName": "deepdetect-js", | ||
"projectOwner": "alx", | ||
"files": [ | ||
"readme.md" | ||
], | ||
"imageSize": 100, | ||
"commit": false, | ||
"contributors": [ | ||
{ | ||
"login": "alx", | ||
"name": "Alexandre Girard", | ||
"avatar_url": "https://avatars2.githubusercontent.com/u/22868432?v=3", | ||
"profile": "https://github.com/alx", | ||
"contributions": [ | ||
"code", | ||
"doc", | ||
"infra" | ||
] | ||
} | ||
] | ||
} |
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,11 @@ | ||
{ | ||
"presets": [ | ||
["env", { | ||
"targets": { "node": 4 } | ||
}], | ||
"flow" | ||
], | ||
"plugins": [ | ||
"add-module-exports" | ||
] | ||
} |
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,12 @@ | ||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
indent_size = 2 | ||
indent_style = space | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
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,3 @@ | ||
dist | ||
coverage | ||
flow-typed |
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,26 @@ | ||
{ | ||
"parser": "babel-eslint", | ||
"extends": [ | ||
"airbnb-base", | ||
"plugin:flowtype/recommended" | ||
], | ||
"env": { | ||
"jest": true, | ||
"node": true | ||
}, | ||
"plugins": [ | ||
"flowtype" | ||
], | ||
"rules": { | ||
"arrow-parens": ["error", "as-needed"], | ||
"comma-dangle": ["error", { | ||
"arrays": "always-multiline", | ||
"objects": "always-multiline", | ||
"imports": "always-multiline", | ||
"exports": "always-multiline", | ||
"functions": "never" | ||
}], | ||
"no-plusplus": ["error", { "allowForLoopAfterthoughts": true }], | ||
"strict": "off" | ||
} | ||
} |
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,9 @@ | ||
[ignore] | ||
.*/dist/.* | ||
.*/node_modules/.* | ||
|
||
[include] | ||
|
||
[libs] | ||
|
||
[options] |
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 @@ | ||
* text=auto | ||
*.js text eol=lf |
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,38 @@ | ||
<!--- Provide a general summary of the issue in the Title above --> | ||
|
||
## I'm submitting a… | ||
<!-- Check one of the following options with "x" --> | ||
- [ ] Regression (a behavior that used to work and stopped working in a new release) | ||
- [ ] Bug report <!-- Please search GitHub for a similar issue or PR before submitting --> | ||
- [ ] Feature request | ||
- [ ] Documentation issue or request | ||
- [ ] Support request | ||
|
||
## Expected Behavior | ||
<!--- If you‘re describing a bug, tell us what should happen --> | ||
<!--- If you‘re suggesting a change/improvement, tell us how it should work --> | ||
|
||
## Current Behavior | ||
<!--- If describing a bug, tell us what happens instead of the expected behavior --> | ||
<!--- If suggesting a change/improvement, explain the difference from current behavior --> | ||
|
||
## Possible Solution | ||
<!--- Not obligatory, but suggest a fix/reason for the bug, --> | ||
<!--- or ideas how to implement the addition or change --> | ||
|
||
## Steps to Reproduce (for bugs) | ||
<!--- Provide a link to a live example, or an unambiguous set of steps to --> | ||
<!--- reproduce this bug. Include code or screenshot if relevant --> | ||
1. | ||
2. | ||
3. | ||
4. | ||
|
||
## Environment | ||
<!--- Include as many relevant details about the environment you experienced the bug in --> | ||
- deepdetect-js version: <!-- run `npm ls deepdetect-js` --> | ||
- Node version: <!-- run `node -v` --> | ||
- NPM version: <!-- run `npm -v` --> | ||
- Yarn version (if you use Yarn): | ||
- Operating system: <!-- Mac, Linux, Windows --> | ||
- Link to your project: |
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,38 @@ | ||
<!--- Provide a general summary of your changes in the Title above --> | ||
|
||
## PR Type | ||
<!--- What types of changes does your code introduce? --> | ||
<!-- Put an `x` in all the boxes that apply: --> | ||
- [ ] Bugfix | ||
- [ ] Feature | ||
- [ ] Code style update (whitespace, formatting, missing semicolons, etc.) | ||
- [ ] Refactoring (no functional changes, no api changes) | ||
- [ ] Build related changes | ||
- [ ] CI related changes | ||
- [ ] Documentation content changes | ||
- [ ] Other… Please describe: | ||
|
||
## Description | ||
<!--- Describe your changes in detail --> | ||
<!--- Why is this change required? What problem does it solve? --> | ||
<!--- If it fixes an open issue, please link to the issue here. --> | ||
|
||
## How Has This Been Tested? | ||
<!--- Please describe in detail how you tested your changes. --> | ||
<!--- Include details of your testing environment, and the tests you ran to --> | ||
<!--- see how your change affects other areas of the code, etc. --> | ||
|
||
## Screenshots (if appropriate): | ||
|
||
## Does this PR introduce a breaking change? | ||
<!-- If this PR contains a breaking change, --> | ||
<!-- please also describe the impact and migration path for existing applications --> | ||
- [ ] Yes | ||
- [ ] No | ||
|
||
## Checklist: | ||
<!--- Put an `x` in all the boxes that apply. --> | ||
<!--- If you‘re unsure about any of these, don‘t hesitate to ask. We‘re here to help! --> | ||
- [ ] My change requires a change to the documentation. | ||
- [ ] I have updated the documentation accordingly. | ||
- [ ] I have read the [`contributing.md`](https://github.com/alx/deepdetect-js/blob/master/contributing.md). |
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,61 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (http://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Typescript v1 declaration files | ||
typings/ | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variables file | ||
.env | ||
|
||
# compiled | ||
dist |
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,14 @@ | ||
language: node_js | ||
notifications: | ||
email: false | ||
node_js: | ||
- 'node' | ||
- '6' | ||
- '4' | ||
script: npm start validate | ||
after_success: | ||
- npm install -g codecov semantic-release | ||
- codecov | ||
- semantic-release pre && npm publish && semantic-release post | ||
branches: | ||
except: /^v\d+\.\d+\.\d+$/ |
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,49 @@ | ||
# 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](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) | ||
|
||
## 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 [nps](https://npmjs.com/package/nps) and you can run `npm start` to see what scripts are available. | ||
|
||
> Tip: Keep your `master` branch pointing at the original repository and make pull requests from branches on your fork. To do this, run: | ||
> | ||
> ``` | ||
> git remote add upstream https://github.com/alx/deepdetect-js | ||
> git fetch upstream | ||
> git branch --set-upstream-to=upstream/master master | ||
> ``` | ||
> | ||
> This will add the original repository as a “remote” called “upstream”, Then fetch the git information from that remote, then set your local `master` branch to use the upstream master branch whenever you run `git pull`. Then you can make all of your pull request branches based on this `master` branch. Whenever you want to update your version of `master`, do a regular `git pull`. | ||
## Add yourself as a contributor | ||
|
||
This project follows the [all contributors](https://github.com/kentcdodds/all-contributors) specification. To add yourself to the table of | ||
contributors on the [`readme.md`](./readme.md), please use the automated script as part of your PR: | ||
|
||
```sh | ||
npm start contributors.add | ||
``` | ||
|
||
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](https://npmjs.com/package/semantic-release) to do automatic releases and generate a changelog based on the | ||
commit history. So we follow [a convention](https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md) for commit messages. You don‘t have to follow this convention if you don‘t like to. Just know that when we merge your commit, we‘ll probably use “Squash and Merge” so we can change the commit message. | ||
|
||
## Help needed | ||
|
||
Please checkout the [`roadmap.md`](./other/roadmap.md) and the open issues. | ||
|
||
Also, please watch the repo and respond to questions/bug reports/feature requests, Thanks! |
Oops, something went wrong.