Skip to content
Permalink
Browse files

Initial commit

  • Loading branch information...
ehmicky committed Aug 7, 2019
0 parents commit 53fada1501eedbdc3009b0d97ffa85c5c370a2b4
@@ -0,0 +1,26 @@
{
"projectName": "nve",
"projectOwner": "ehmicky",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 100,
"commit": true,
"contributors": [
{
"login": "ehmicky",
"name": "ehmicky",
"avatar_url": "https://avatars2.githubusercontent.com/u/8136211?v=4",
"profile": "https://twitter.com/ehmicky",
"contributions": [
"code",
"design",
"ideas",
"doc"
]
}
],
"contributorsPerLine": 7
}
@@ -0,0 +1,10 @@
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
max_line_length = 80
trim_trailing_whitespace = true
insert_final_newline = true
@@ -0,0 +1 @@
extends: standard-prettier-fp/.eslintrc.yml
@@ -0,0 +1 @@
* text=auto eol=lf
@@ -0,0 +1,57 @@
---
name: Bug report
about: Create a report to help us improve
title: 'Please replace with a clear and descriptive title'
labels: bug
assignees: ''
---

Thanks for reporting this bug!

If this is related to a typo or the documentation being unclear, please click on
the relevant page's `Edit` button (pencil icon) and suggest a correction
instead.

Please search other issues to make sure this bug has not already been reported.

Then fill in the sections below.

**Describe the bug**

A clear and concise description of what the bug is.

**Steps to reproduce**

Step-by-step instructions on how to reproduce the behavior.

Example:

1. Type the following command: [...]
2. etc.

**Expected behavior**

A clear and concise description of what you expected to happen.

**Configuration**

Command line options and/or configuration file, if any.

**Environment**

Enter the following command in a terminal and copy/paste its output:

```bash
npx envinfo --system --binaries --browsers --npmPackages nve
```

**Screenshots**

If applicable, add screenshots to help explain your problem.

**Can you submit a pull request?**

Yes/No.

Pull requests are welcome! If you would like to help us fix this bug, please
check our [contributions guidelines](../blob/master/CONTRIBUTING.md).
@@ -0,0 +1,30 @@
---
name: Feature request
about: Suggest an idea for this project
title: 'Please replace with a clear and descriptive title'
labels: enhancement
assignees: ''
---

Thanks for suggesting a new feature!

Please fill in the sections below.

**Which problem is this feature request solving?**

Example: I'm always frustrated when [...]

**Describe the solution you'd like**

Example: This could be fixed by [...]

**Describe alternatives you've considered**

Example: Another solution would be [...]

**Can you submit a pull request?**

Yes/No.

Pull requests are welcome! If you would like to help us add this feature, please
check our [contributions guidelines](../blob/master/CONTRIBUTING.md).
@@ -0,0 +1,34 @@
🎉 Thanks for sending this pull request! 🎉

Please make sure the title is clear and descriptive.

If you are fixing a typo or documentation, please skip these instructions.

Otherwise please fill in the sections below.

**Which problem is this pull request solving?**

Example: I'm always frustrated when [...]

**List other issues or pull requests related to this problem**

Example: This fixes #5012

**Describe the solution you've chosen**

Example: I've fixed this by [...]

**Describe alternatives you've considered**

Example: Another solution would be [...]

**Checklist**

Please add a `x` inside each checkbox:

- [ ] I have read the [contribution guidelines](../blob/master/CONTRIBUTING.md).
- [ ] I have added tests (we are enforcing 100% test coverage).
- [ ] I have added documentation in the `README.md`, the `docs` directory (if
any) and the `examples` directory (if any).
- [ ] The status checks are successful (continuous integration). Those can be
seen below.
@@ -0,0 +1,12 @@
*~
*.swp
npm-debug.log
node_modules
/core
.eslintcache
.npmrc
.yarn-error.log
.nyc_output
!.github/
/coverage
/build
@@ -0,0 +1 @@
eslint-config-standard-prettier-fp
@@ -0,0 +1,39 @@
language: node_js
node_js: '12'
dist: xenial
# When pushing a tagged commit, Travis adds two builds: one with the tag, one
# without. We only want to build the one with the tag, because it's the one
# that runs the deployment stage
if: '!(commit_message =~ /^Release/ && tag is blank)'
jobs:
include:
# Test on Windows/Mac/Linux using latest Node.js.
# Also test on Linux with older Node.js versions.
# We do not run each possible combination to make CI faster.
- os: windows
- os: osx
- node_js: '8.12.0'
- node_js: '12'
# Test coverage check must happen after tests for the whole matrix have
# been performed, so we get the merged coverage map
- stage: Coverage check
# If this fails during a PR, CI will fail. However when CI fails, codecov
# does not post any comment. Since codecov comments are nicer than
# Travis Buddy comments for this, we skip it during PRs. Also this makes
# PRs checks faster.
if: type != pull_request
script: gulp coverage
# Deployment must happen after tests for the whole matrix have been
# performed, so we use `jobs.include` with a different `stage`.
- stage: Deploy
if: type != pull_request && tag is not blank
script: gulp publish
# NPM_TOKEN environment variable
env:
secure: 'DaRvy+9kUN2hmh/X1u6cefAUInQWlBqsAvSGOiwdcjPRDguE+nNUnJ5TPKzAX/OUk0GJ4BtnTfr+7HgBh1dQswxQD9HnpZ2E7qyUrLhAaPJcaM9IciRJxkr4mbxmJ+WWvshg7/80gdY3p4UYaPS/lAKo+RPvTXwe0uZkiAzTGhKBfDHtHv8LB2uIgXAzslgZq/yvidLCD2yiQujVPnhEKeotJeUXBEr9A3uxLoNxo96lK2kPEux+qdW4tuHSH2qaZPFD/JEQGA+fiXoKgvFh3Ha925owcXJOdnKqQL5gbd9kwrb333VOLq9HsONS59sgBbEhh/4xWJgtMV8FurulHeW/eGqCcvPtnrzAhaVzS+iHb5CvRnj+uJwah6k2TjlCIVxZiNxMNTn0g+F1ru4bsUWTcGR5kRCzxXhJXfrpFxKJbesfzmOJvLalbUwjoOtKUavid/n1XqgwkRFthoD4kty6VIMR3DvdhSoFagK/Zawn36S7PWG+KagZYJRUhDH3gg7DKn7EMuqIrhZuJwxPGXQZsmy1Y+z/uX8mNq5INw2s+lE3tn/KvBki8wTHrOwzgKsg5nODUk0A+/8nxMNJ5kJ2O1HxBsOEtmgNgllnYkwrrNCSG9pcFSySRbjYkB2Y+Xt8tNm0xUcPov0oGE6abnccyGzTeeQB9ptFI6LlvWo='
notifications:
webhooks:
- https://www.travisbuddy.com?only=failed,errored&insertMode=update
email: false
# We do not use `cache: npm` because downloading and uploading the cache
# actually takes more time than it saves during `npm ci`.
No changes.
@@ -0,0 +1,81 @@
# Code of Conduct

This text is available in
[many other languages](https://www.contributor-covenant.org/translations).

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and
expression, level of experience, education, socio-economic status, nationality,
personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at ehmicky+report@gmail.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an
incident. Further details of specific enforcement policies may be posted
separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
@@ -0,0 +1,60 @@
# Contributions

🎉 Thanks for considering contributing to this project! 🎉

These guidelines will help you send a pull request.

If you're submitting an issue instead, please skip this document.

If your pull request is related to a typo or the documentation being unclear,
please click on the relevant page's `Edit` button (pencil icon) and directly
suggest a correction instead.

This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.

Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
inclusive environment.

# Development process

First fork and clone the repository. If you're not sure how to do this, please
watch
[these videos](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).

Run:

```bash
npm install
```

Make sure everything is correctly setup with:

```bash
npm test
```

We use Gulp tasks to lint, test and build this project. Please check
[gulp-shared-tasks](https://github.com/ehmicky/gulp-shared-tasks/blob/master/README.md)
to learn how to use them. You don't need to know Gulp to use these tasks.

# Requirements

Our coding style is documented
[here](https://github.com/ehmicky/eslint-config-standard-prettier-fp#coding-style).
Linting and formatting should automatically handle it though.

After submitting the pull request, please make sure the Continuous Integration
checks are passing.

We enforce 100% test coverage: each line of code must be tested.

New options, methods, properties, configuration and behavior must be documented
in all of these:

- the `README.md`
- the `docs` directory (if any)
- the `examples` directory (if any)

Please use the same style as the rest of the documentation and examples.

0 comments on commit 53fada1

Please sign in to comment.
You can’t perform that action at this time.