Skip to content

Commit 38b7dce

Browse files
committed
Implement license, docs and update go module
1 parent 2fb8a15 commit 38b7dce

File tree

6 files changed

+135
-8
lines changed

6 files changed

+135
-8
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ dist/
99
**/reflex.lock
1010
**/.idea/
1111
**/.vscode/
12-
12+
.gocache/

CODE_OF_CONDUCT.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
Contributor Covenant Code of Conduct
2+
====================================
3+
4+
Our Pledge
5+
----------
6+
We as members, contributors, and leaders pledge to make participation in our community a harassment‑free experience for everyone, regardless of age, body size, visible or invisible 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.
7+
8+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
9+
10+
Our Standards
11+
-------------
12+
Examples of behavior that contributes to a positive environment include:
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
21+
- Trolling, insulting or derogatory comments, and personal or political attacks
22+
- Public or private harassment
23+
- Publishing others’ private information, such as a physical or email address, without their explicit permission
24+
- Other conduct which could reasonably be considered inappropriate in a professional setting
25+
26+
Enforcement Responsibilities
27+
----------------------------
28+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior they deem inappropriate, threatening, offensive, or harmful.
29+
30+
Scope
31+
-----
32+
This Code of Conduct applies within all community spaces and also applies when an individual is officially representing the community in public spaces.
33+
34+
Enforcement
35+
-----------
36+
If you experience or witness unacceptable behavior, please contact the maintainers privately. If no private contact is published, open a minimal issue requesting a private contact channel. All complaints will be reviewed and investigated promptly and fairly.
37+
38+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
39+
40+
Attribution
41+
-----------
42+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1.
43+
44+
[homepage]: https://www.contributor-covenant.org
45+
46+
For answers to common questions about this code of conduct, see the FAQ at
47+
https://www.contributor-covenant.org/faq. Translations are available at
48+
https://www.contributor-covenant.org/translations.
49+

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Contributing to Reflex
2+
======================
3+
4+
Thanks for your interest in contributing! This document describes how to build, test, and propose changes.
5+
6+
Prerequisites
7+
-------------
8+
- Go 1.21+
9+
- mkcert available on your PATH (for running the CLI; unit tests generate self‑signed certs and do not require mkcert)
10+
11+
Getting started
12+
---------------
13+
1) Fork the repository and create a feature branch.
14+
15+
2) Build and test:
16+
17+
```
18+
make build
19+
make test
20+
```
21+
22+
If your environment restricts binding/listening (e.g., CI sandboxes), some network‑related tests may need to be skipped or run locally.
23+
24+
3) Run the CLI locally (requires admin privileges to modify hosts and bind to 443; falls back to 8443 if needed):
25+
26+
```
27+
sudo ./bin/reflex run \
28+
--referrer https://news.google.com \
29+
--target https://your-app.example
30+
```
31+
32+
4) Lint/format:
33+
34+
```
35+
make fmt
36+
```
37+
38+
Submitting changes
39+
------------------
40+
- Keep PRs focused and small. Include a short rationale in the description.
41+
- Add or update tests for any functional changes.
42+
- Update documentation (`README.md` and/or inline help) where behavior or flags change.
43+
- Follow the Code of Conduct (see CODE_OF_CONDUCT.md).
44+
45+
Release process
46+
---------------
47+
- Tags of the form `vX.Y.Z` trigger GoReleaser to build archives for Linux/macOS/Windows.
48+
- Please ensure tests pass on CI prior to release tags.
49+
50+
Security
51+
--------
52+
Please do not file public issues for security‑sensitive reports. Instead, contact the maintainers privately (open an issue requesting a contact if no address is published).
53+
54+
License
55+
-------
56+
By contributing, you agree that your contributions will be licensed under the MIT License (see LICENSE).
57+

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Reflex contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

cmd/reflex/main.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ import (
1313
"syscall"
1414
"time"
1515

16-
"reflex/internal/browser"
17-
"reflex/internal/certs"
18-
"reflex/internal/hosts"
19-
"reflex/internal/server"
20-
"reflex/internal/util"
16+
"github.com/samfrm/reflex/internal/browser"
17+
"github.com/samfrm/reflex/internal/certs"
18+
"github.com/samfrm/reflex/internal/hosts"
19+
"github.com/samfrm/reflex/internal/server"
20+
"github.com/samfrm/reflex/internal/util"
2121
)
2222

2323
const (

go.mod

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
module reflex
1+
module github.com/samfrm/reflex
22

33
go 1.21
4-

0 commit comments

Comments
 (0)