Skip to content

Commit 9864bff

Browse files
committed
contributing and license
1 parent 519d0d1 commit 9864bff

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# I405 Contribution Guide
2+
3+
Follow the typical Github contribution flow:
4+
1. Create an issue about what you want to work on so we can discuss it before you spend a lot of time working on it.
5+
2. Fork the repo and create a branch. There's no strict naming scheme on branches.
6+
3. Do the work.
7+
4. Open a pull request.
8+
9+
I405-specific policies to be aware of:
10+
+ LLM-generated code is permitted if it is clearly marked by a comment. That being said, LLMs were
11+
only used to help write tests in the initial I405 implementation, and even then sparingly because
12+
LLMs have a tendency to write tests that mirror the implementation. Please carefully read any code
13+
generated by an LLM.
14+
+ All tests, including ignored tests, should pass: `cargo test -- --include-ignored --test-threads
15+
100`. We use ignored tests to indicate tests that don't finish instantly, rather than broken
16+
tests. At the time of writing, the slow tests are slow because they have to `sleep` because
17+
wolfSSL uses the system time for certain timeouts (see
18+
https://github.com/expressvpn/lightway/issues/203). (If you have to introduce a test that doesn't
19+
pass yet for some reason, use `#cfg[any()]` instead of `#[ignore]`).
20+
21+
Also, end-to-end test must pass: `end-to-end-tests/e2e_test.py`.
22+
+ Add tests for important parts of all "pure" behavior. Changes to the "hardware" implementations
23+
can be difficult to test (apart from e2e-tests), please describe what you've done to verify your
24+
implementation is correct because we don't test the hardware implementations (outside of the
25+
end-to-end test).
26+
+ I405 is released under the MIT license. By opening a pull request you indicate that you are
27+
releasing your contribution under the MIT license also. No copyright assignment is required.

LICENSE

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

0 commit comments

Comments
 (0)