Skip to content

Commit 835cfbf

Browse files
Merge branch 'master' into master
2 parents b7caf44 + 72b6b07 commit 835cfbf

30 files changed

+4953
-6243
lines changed

.eslintrc.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"extends": "eslint-config-populist",
3+
"rules": {
4+
"strict": "warn",
5+
"indent": ["warn", 2],
6+
"valid-jsdoc": "warn",
7+
"no-undefined": "warn",
8+
"comma-dangle": "warn",
9+
"callback-return": ["warn", ["next"]]
10+
}
11+
}

.github/CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to http-server
2+
3+
> Please read these guidelines before submitting an issue, filing a feature request, or contributing code.
4+
5+
## :bug: I Found a Bug
6+
7+
Sorry! It happens to the best of us. If you've found a bug in http-server, **please [search](https://github.com/http-party/http-server/issues/) to see if it's already been reported**. Otherwise, create a [new issue](https://github.com/http-party/http-server/issues/new). If you can fix the bug yourself, feel free to create a [pull request](#propose-a-change) thereafter.
8+
9+
Please include _as much detail as possible_ to help us reproduce and diagnose the bug. Most importantly:
10+
11+
- Make use of the issue template!
12+
- Let us know _how_ you're running http-server (options, flags, environment, etc.)
13+
- Include your test code or file(s). If large, please provide a link to a repository or [gist](https://gist.github.com).
14+
- Please show code in JavaScript only (any version)
15+
16+
If we need more information from you, we'll let you know. If you don't within a reasonable time frame (TBD), your issue will be automatically tagged as stale and eventually closed for inactivity.
17+
18+
## :exclamation: Propose a Change
19+
20+
Before you get your hands dirty, please [search](https://github.com/http-party/http-server/issues/) for a related issue, or [create a new one](https://github.com/http-party/http-server/issues/new). If you wish to contribute a new feature, this is doubly important! Let's discuss your proposed changes first; we don't want you to waste time implementing a change that is at odds with the project's direction. That said, we'll happily consider any contribution, no matter how great or small.
21+
22+
### :shoe: Contributing Code: Step-by-Step
23+
24+
Follow these steps to get going.
25+
26+
1. [Install the latest version of Node.js](https://nodejs.org/en/download).
27+
- If you're new to installing Node, a tool like [nvm](https://github.com/creationix/nvm#install-script) can help you manage multiple version installations.
28+
1. Follow [Github's documentation](https://help.github.com/articles/fork-a-repo/) on setting up Git, forking and cloning.
29+
1. Create a new branch in your fork, giving it a descriptive name
30+
1. Execute `npm install` to install the prod and dev dependencies
31+
- Do not use `yarn install` for development, as it may not get the same package versions as other developers.
32+
1. Make your changes and add them via `git add`.
33+
- **Tests are required** for any non-trivial code change. If you're having trouble making tests, go ahead and open the pull request and we can help
34+
- Keep your PR focused. Don't fix multiple things at once, and don't upgrade dependencies unless necessary.
35+
1. Before committing, run `npm test`
36+
- Tests will also run on your PR, but running them locally will let you catch problems ahead-of-time.
37+
1. Commit your changes.
38+
- See [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/).
39+
- **Please do not use "Conventional Commits" style**
40+
1. Push your changes to your fork.
41+
1. Now on [http-party/http-server](https://github.com/http-party/http-server), you should see a notification about your recent changes in your fork's branch, with a green button to create a pull request. Click the button.
42+
1. Describe your changes in detail here, following the template. Once you're satisfied, submit the form.
43+
1. Be patient while your PR is reviewed. This can take a while. We may request changes, but don't be afraid to question them.
44+
1. Your PR might become conflicted with the code in `master`. If this is the case, you will need to [update your PR](#up-to-date) and resolve your conflicts.
45+
1. You don't need to make a new PR to any needed changes. Instead, commit on top of your changes, and push these to your fork's branch. The PR will be updated, and CI will re-run.
46+
- **Please do not rebase and force-push**, it ruins the git history
47+
48+
## :angel: I Just Want To Help
49+
50+
_Excellent._ Here's how:
51+
52+
- **Handy with JavaScript?** Please check out the issues labeled [`help-wanted`](https://github.com/http-party/http-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22help-wanted%22) or [`good first issue`](https://github.com/http-party/http-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Agood+first+issue).
53+
- **Wait--you write unit tests for _fun_?** A PR which increases coverage is unlikely to ever be turned down.

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: thornjad

.github/ISSUE_TEMPLATE

Lines changed: 0 additions & 18 deletions
This file was deleted.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
6+
<!-- Describe the issue briefly here. -->
7+
8+
#### Environment Versions
9+
10+
1. OS Type
11+
1. Node version: `$ node --version`
12+
1. http-server version: `$ http-server --version`
13+
14+
#### Steps to reproduce
15+
16+
<!-- Include the actual command -->
17+
18+
1. ...
19+
2. ...
20+
3. ...
21+
22+
#### Expected result
23+
24+
...
25+
26+
#### Actual result
27+
28+
<!-- Include full output and/or stack trace -->
29+
30+
...
31+
32+
#### Other information
33+
34+
<!-- Include related issues, suggestions for a fix or further debug information, etc. -->
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
---
5+
6+
#### What's the problem this feature will solve?
7+
8+
<!-- What are you trying to do, that you are unable to achieve with http-server as it currently stands? -->
9+
10+
#### Describe the solution you'd like
11+
12+
<!-- A clear and concise description of what you want to happen. -->
13+
14+
<!-- Provide examples of real-world use cases that this would enable and how it solves the problem described above. -->
15+
16+
#### Alternative Solutions
17+
18+
<!-- Have you tried to workaround the problem using http-server or other tools? Or a different approach to solving this issue? Please elaborate here. -->
19+
20+
#### Additional context
21+
22+
<!-- Add any other context, links, etc. about the feature here. -->

.github/PULL_REQUEST_TEMPLATE

Lines changed: 0 additions & 23 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--- Describe the changes here. --->
2+
3+
##### Relevant issues
4+
5+
<!--
6+
Link to the issue(s) this pull request fixes here, if applicable: "Fixes #xxx" or "Resolves #xxx"
7+
8+
If your PR fixes multiple issues, list them individually like "Fixes #xx1, fixes #xx2, fixes #xx3". This is a quirk of how GitHub links issues.
9+
-->
10+
11+
##### Contributor checklist
12+
13+
- [ ] Provide tests for the changes (unless documentation-only)
14+
- [ ] Documented any new features, CLI switches, etc. (if applicable)
15+
- [ ] Server `--help` output
16+
- [ ] README.md
17+
- [ ] doc/http-server.1 (use the same format as other entries)
18+
- [ ] The pull request is being made against the `master` branch
19+
20+
##### Maintainer checklist
21+
22+
- [ ] Assign a version triage tag
23+
- [ ] Approve tests if applicable

.github/release-drafter.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name-template: 'v$RESOLVED_VERSION'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
4+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
5+
change-title-escapes: '\<*_&'
6+
7+
categories:
8+
- title: 'Breaking changes'
9+
labels:
10+
- 'major version'
11+
- title: 'Features and enhancements'
12+
labels:
13+
- 'feature'
14+
- 'enhancement'
15+
- title: 'Bug Fixes'
16+
labels:
17+
- 'fix'
18+
- 'bug'
19+
- title: 'Other changes'
20+
labels:
21+
- 'dependencies'
22+
- 'documentation'
23+
24+
exclude-labels:
25+
- "skip-changelog"
26+
- "maintenance"
27+
- "trivial"
28+
29+
version-resolver:
30+
major:
31+
labels:
32+
- 'major version'
33+
minor:
34+
labels:
35+
- 'minor version'
36+
patch:
37+
labels:
38+
- 'patch version'
39+
default: patch
40+
41+
template: |
42+
$CHANGES

.github/workflows/node.js.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
strategy:
1818
fail-fast: false
1919
matrix:
20-
node-version: [12.x, 14.x, 16.x]
20+
node-version: [12.x, 14.x, 16.x, 17.x]
2121
os: [ubuntu-latest, macOS-latest, windows-latest]
2222

2323
steps:

0 commit comments

Comments
 (0)