Skip to content

Commit 0fa9603

Browse files
committed
Add looking for contributors message
1 parent bc34bed commit 0fa9603

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

Looking-for-contributor.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# I'm looking for contributors!
2+
I would like to totally rewrite this package in a brand new version 5 and I'm looking for help!
3+
With the right help I would also like to switch to an organization on GitHub for advanced features.
4+
5+
## What we want to do
6+
- [ ] Port https-localhost in TypeScript (from JS). I'm working on it and I would like to discuss the final structure of the module.
7+
- [ ] Improve the CLI with option and config files.
8+
- [ ] Evaluate if make sense to split into two separate packages: the CLI and the module. The new CLI may add new dependency and many users use it as module.
9+
- [ ] Switch to more lightweight dependencies (possibly replacing express) to reduce the module size. Evaluate the remotion of less user features that have dependencies (e.g. compression, minify).
10+
- [ ] Structured docs.
11+
- [ ] Publish on brew.
12+
- [ ] Improve the Actions: CI, Release, automatic dependencies upgrade and more.
13+
- [ ] Write a VSCode extension that integrates this project into the IDE.
14+
- [ ] Evaluate Deno compatibility support: lately, some tools for automatic rewriting of imports are coming out, reducing the burden.
15+
- [ ] Optionally, implement a minimal UI (an executable with drag & drop) for users who are not comfortable with the CLI.
16+
17+
18+
## Who I'm looking for
19+
- Stable **maintainers**, to discuss the project together and take design choices.
20+
- Casual **contributors**, who would like to work on a feature or on a task, improve docs, optimize code or fix bugs.
21+
- **Testers**, who can help us find bugs and verify the correct functioning of patches and new features.
22+
23+
### What you need
24+
- Ability to work in a team
25+
- Patience, courtesy, and respect
26+
- Desire to get involved and build something useful
27+
28+
#### Appreciated, but not required to contribute
29+
- TypeScript/javaScript knowledge (but at least desire to learn it, of course!)
30+
- Experience designing a module or a project implementation
31+
32+
### What to keep away
33+
- Presumption
34+
- Claims (of money, power, or other benefits): it's a free, open-source project
35+
36+
37+
## What I can offer
38+
- All my thankfulness and gratitude
39+
- A place in the Contributors section of the README.md (that will be created soon)

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# HTTPS server running on localhost
2+
3+
| I'm looking for maintainers and contributors! [Learn more](Looking-for-contributor.md). |
4+
|-----------------------------------------------------------------------------------------|
5+
26
Run an express server on localhost with HTTP2 and SSL. Serve static files or import as module in your project.
37

48
https-localhost is a lightweight tool for serving static content on SSL thanks to locally-trusted development certificates.

0 commit comments

Comments
 (0)