From c1fbc624c6ab7751903b7e56b3310bd8c793711a Mon Sep 17 00:00:00 2001 From: doowb Date: Mon, 17 Jun 2019 16:03:27 -0400 Subject: [PATCH] run update --- .eslintrc.json | 4 ++ .github/contributing.md | 85 +++++++++++++++++++++++++++++++++++++++++ .npmrc | 1 + .travis.yml | 10 ++--- LICENSE | 4 +- appveyor.yml | 26 ------------- package.json | 7 +++- 7 files changed, 101 insertions(+), 36 deletions(-) create mode 100644 .github/contributing.md create mode 100644 .npmrc delete mode 100644 appveyor.yml diff --git a/.eslintrc.json b/.eslintrc.json index 61e8895..0d75e59 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -6,6 +6,10 @@ "mocha": true }, + "parserOptions": { + "ecmaVersion": 10 + }, + "globals": { "document": false, "navigator": false, diff --git a/.github/contributing.md b/.github/contributing.md new file mode 100644 index 0000000..5680e7b --- /dev/null +++ b/.github/contributing.md @@ -0,0 +1,85 @@ +# Contributing to npm-api + +First and foremost, thank you! We appreciate that you want to contribute to npm-api, your time is valuable, and your contributions mean a lot to us. + +## Important! + +By contributing to this project, you: + +* Agree that you have authored 100% of the content +* Agree that you have the necessary rights to the content +* Agree that you have received the necessary permissions from your employer to make the contributions (if applicable) +* Agree that the content you contribute may be provided under the Project license(s) + +## Getting started + +**What does "contributing" mean?** + +Creating an issue is the simplest form of contributing to a project. But there are many ways to contribute, including the following: + +- Updating or correcting documentation +- Feature requests +- Bug reports + +If you'd like to learn more about contributing in general, the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) has a lot of useful information. + +**Showing support for npm-api** + +Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use. + +Don't have time to contribute? No worries, here are some other ways to show your support for npm-api: + +- star the [project](https://github.com/doowb/npm-api) +- tweet your support for npm-api + +## Issues + +### Before creating an issue + +Please try to determine if the issue is caused by an underlying library, and if so, create the issue there. Sometimes this is difficult to know. We only ask that you attempt to give a reasonable attempt to find out. Oftentimes the readme will have advice about where to go to create issues. + +Try to follow these guidelines + +- **Avoid creating issues for implementation help**. It's much better for discoverability, SEO, and semantics - to keep the issue tracker focused on bugs and feature requests - to ask implementation-related questions on [stackoverflow.com][so] +- **Investigate the issue**: +- **Check the readme** - oftentimes you will find notes about creating issues, and where to go depending on the type of issue. +- Create the issue in the appropriate repository. + +### Creating an issue + +Please be as descriptive as possible when creating an issue. Give us the information we need to successfully answer your question or address your issue by answering the following in your issue: + +- **version**: please note the version of npm-api are you using +- **extensions, plugins, helpers, etc** (if applicable): please list any extensions you're using +- **error messages**: please paste any error messages into the issue, or a [gist](https://gist.github.com/) + +### Closing issues + +The original poster or the maintainer's of npm-api may close an issue at any time. Typically, but not exclusively, issues are closed when: + +- The issue is resolved +- The project's maintainers have determined the issue is out of scope +- An issue is clearly a duplicate of another issue, in which case the duplicate issue will be linked. +- A discussion has clearly run its course + + +## Next steps + +**Tips for creating idiomatic issues** + +Spending just a little extra time to review best practices and brush up on your contributing skills will, at minimum, make your issue easier to read, easier to resolve, and more likely to be found by others who have the same or similar issue in the future. At best, it will open up doors and potential career opportunities by helping you be at your best. + +The following resources were hand-picked to help you be the most effective contributor you can be: + +- The [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) is a great place for newcomers to start, but there is also information for experienced contributors there. +- Take some time to learn basic markdown. We can't stress this enough. Don't start pasting code into GitHub issues before you've taken a moment to review this [markdown cheatsheet](https://gist.github.com/jonschlinkert/5854601) +- The GitHub guide to [basic markdown](https://help.github.com/articles/markdown-basics/) is another great markdown resource. +- Learn about [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). And if you want to really go above and beyond, read [mastering markdown](https://guides.github.com/features/mastering-markdown/). + +At the very least, please try to: + +- Use backticks to wrap code. This ensures that it retains its formatting and isn't modified when it's rendered by GitHub, and makes the code more readable to others +- When applicable, use syntax highlighting by adding the correct language name after the first "code fence" + + +[so]: http://stackoverflow.com/questions/tagged/npm-api diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..43c97e7 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/.travis.yml b/.travis.yml index 67decb2..ce7ae03 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,13 +2,9 @@ sudo: false os: - linux - osx + - windows language: node_js node_js: - node - - '8' - - '7' - - '6' - - '5' - - '4' - - '0.12' - - '0.10' + - '12' + - '10' diff --git a/LICENSE b/LICENSE index b70671f..c410d4d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2015-2017, Brian Woodward. +Copyright (c) 2015-2019, Brian Woodward. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +THE SOFTWARE. \ No newline at end of file diff --git a/appveyor.yml b/appveyor.yml deleted file mode 100644 index 52b11b8..0000000 --- a/appveyor.yml +++ /dev/null @@ -1,26 +0,0 @@ -# Test against this version of Node.js -environment: - matrix: - # node.js - - nodejs_version: "9.0" - - nodejs_version: "8.0" - - nodejs_version: "6.0" - - nodejs_version: "4.0" - -# Install scripts. (runs after repo cloning) -install: - # Get the latest stable version of Node.js or io.js - - ps: Install-Product node $env:nodejs_version - # install modules - - npm install - -# Post-install test scripts. -test_script: - # Output useful info for debugging. - - node --version - - npm --version - # run tests - - npm test - -# Don't actually build. -build: off diff --git a/package.json b/package.json index 746031d..0a42891 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,11 @@ "version": "0.4.13", "homepage": "https://github.com/doowb/npm-api", "author": "Brian Woodward (https://github.com/doowb)", + "contributors": [ + "0xflotus (https://github.com/0xflotus)", + "Brian Woodward (https://twitter.com/doowb)", + "Nachman Berkowitz (https://github.com/NachmanBerkowitz)" + ], "repository": "doowb/npm-api", "bugs": { "url": "https://github.com/doowb/npm-api/issues" @@ -15,7 +20,7 @@ ], "main": "index.js", "engines": { - "node": ">=0.10.0" + "node": ">=10.0" }, "scripts": { "test": "mocha"