Skip to content

Commit 779f818

Browse files
Initial commit
0 parents  commit 779f818

11 files changed

+9037
-0
lines changed

.env.example

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
GITHUB_USER=anonymous
2+
NETLIFY_WEBHOOK=https://api.netlify.com/build_hooks/XXXXXXXXXXXXX

.gitignore

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# node-waf configuration
29+
.lock-wscript
30+
31+
# Compiled binary addons (https://nodejs.org/api/addons.html)
32+
build/Release
33+
34+
# Dependency directories
35+
**/node_modules/
36+
**/jspm_packages/
37+
38+
# TypeScript v1 declaration files
39+
**/typings/
40+
41+
# TypeScript cache
42+
*.tsbuildinfo
43+
44+
# Optional npm cache directory
45+
.npm
46+
47+
# Optional eslint cache
48+
.eslintcache
49+
50+
# Optional REPL history
51+
.node_repl_history
52+
53+
# Output of 'npm pack'
54+
*.tgz
55+
56+
# Yarn Integrity file
57+
.yarn-integrity
58+
59+
# environment / secret variables file
60+
**/.env
61+
**/.env.test
62+
*.pem
63+
!mock-cert.pem
64+
65+
# build / generate output
66+
**/coverage
67+
**/demo/dist
68+
**/es
69+
**/lib
70+
**/umd
71+
72+
# Serverless directories
73+
**/.serverless/
74+
75+
.DS_Store
76+
plugin

CODE_OF_CONDUCT.md

+74
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+
education, socio-economic status, nationality, personal appearance, race,
10+
religion, or sexual identity and 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 . 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+

CONTRIBUTING.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
## Contributing
2+
3+
[fork]: /fork
4+
[pr]: /compare
5+
[style]: https://standardjs.com/
6+
[code-of-conduct]: CODE_OF_CONDUCT.md
7+
8+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
9+
10+
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
11+
12+
## Issues and PRs
13+
14+
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
15+
16+
We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
17+
18+
## Submitting a pull request
19+
20+
1. [Fork][fork] and clone the repository.
21+
1. Configure and install the dependencies: `npm install`.
22+
1. Make sure the tests pass on your machine: `npm test`, note: these tests also apply the linter, so there's no need to lint separately.
23+
1. Create a new branch: `git checkout -b my-branch-name`.
24+
1. Make your change, add tests, and make sure the tests still pass.
25+
1. Push to your fork and [submit a pull request][pr].
26+
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
27+
28+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
29+
30+
- Follow the [style guide][style] which is using standard. Any linting errors should be shown when running `npm test`.
31+
- Write and update tests.
32+
- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
33+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
34+
35+
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
36+
37+
## Resources
38+
39+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
40+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
41+
- [GitHub Help](https://help.github.com)
42+
43+
## Prerequisites
44+
45+
[Node.js](http://nodejs.org/) >= 6 must be installed.
46+
47+
## Installation
48+
49+
- Running `npm install` in the module's root directory will install everything you need for development.
50+
51+
## Running Tests
52+
53+
- `npm test` will run the tests once.
54+
55+
- `npm run test:coverage` will run the tests and produce a coverage report in `coverage/`.
56+
57+
- `npm run test:watch` will run the tests on every change.
58+
59+
## Building
60+
61+
- `npm run build` will build the module for publishing to npm.
62+
63+
- `npm run clean` will delete built resources.

0 commit comments

Comments
 (0)