Skip to content

Commit ae6f403

Browse files
doitiandoitian
committed
🎉 Setup the repo
0 parents  commit ae6f403

File tree

13 files changed

+254
-0
lines changed

13 files changed

+254
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: "🐛 Bug"
2+
description: File a bug/issue
3+
title: ":bug: <title>"
4+
labels: ["bug", "triage"]
5+
# projects: []
6+
# assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
13+
Remember, contributions to this repository should follow its [contributing guidelines](../blob/develop/docs/CONTRIBUTING.md).
14+
- type: checkboxes
15+
attributes:
16+
label: Is there an existing issue for this?
17+
description: Please search to see if an issue already exists for the bug you encountered.
18+
options:
19+
- label: I have searched the existing issues
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Current Behavior
24+
description: A concise description of what you're experiencing.
25+
validations:
26+
required: false
27+
- type: textarea
28+
attributes:
29+
label: Expected Behavior
30+
description: A concise description of what you expected to happen.
31+
validations:
32+
required: false
33+
- type: textarea
34+
attributes:
35+
label: Steps To Reproduce
36+
description: Steps to reproduce the behavior.
37+
placeholder: |
38+
1. In this environment...
39+
1. With this config...
40+
1. Run '...'
41+
1. See error...
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Environment
47+
description: |
48+
examples:
49+
- **Packages**: @ckb-cobuild/cobuild@0.0.4
50+
- **OS**: Ubuntu 20.04
51+
- **Node**: v21.5.0
52+
- **pnpm**: 8.6.12
53+
value: |
54+
- **Packages**:
55+
- **OS**:
56+
- **Node**:
57+
- **pnpm**:
58+
validations:
59+
required: false
60+
- type: textarea
61+
attributes:
62+
label: Anything else?
63+
description: |
64+
Links? References? Anything that will give us more context about the issue you are encountering!
65+
66+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.

‎.github/ISSUE_TEMPLATE/config.yml‎

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

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: "✨ Feature"
2+
description: Request a feature
3+
title: ":sparkles: <title>"
4+
labels: ["feature", "triage"]
5+
# projects: []
6+
# assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this feature request!
12+
13+
Remember, contributions to this repository should follow its [contributing guidelines](../blob/develop/docs/CONTRIBUTING.md).
14+
- type: checkboxes
15+
attributes:
16+
label: Is there an existing issue for this?
17+
description: Please search to see if an issue already exists for the feature you are requesting.
18+
options:
19+
- label: I have searched the existing issues
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Describe The Problem
24+
description: Please present a concise description of the problem to be addressed by this feature request. Please be clear what parts of the problem are considered to be in-scope and out-of-scope.
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: Suggest A Solution
30+
description: |
31+
A concise description of your preferred solution. If there are multiple solutions, please present each one separately. Save comparisons for the very end.
32+
placeholder: |
33+
Things to address include:
34+
- Details of the technical implementation
35+
- Tradeoffs made in design decisions
36+
- Caveats and considerations for the future
37+
validations:
38+
required: false
39+
- type: textarea
40+
attributes:
41+
label: Anything else?
42+
description: |
43+
Links? References? Anything that will give us more context about the feature you are requesting!
44+
45+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
46+
validations:
47+
required: false

‎.github/workflows/ci.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main, develop]
6+
pull_request:
7+
types: [opened, synchronize]
8+
9+
jobs:
10+
matrix:
11+
name: Build and Test
12+
timeout-minutes: 15
13+
runs-on: ubuntu-latest
14+
15+
strategy:
16+
fail-fast: false
17+
matrix:
18+
toolchain:
19+
- "1.76.0"
20+
- stable
21+
- beta
22+
- nightly
23+
steps:
24+
- uses: actions/checkout@v4
25+
- run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }}
26+
- run: cargo build --verbose
27+
- run: cargo test --verbose
28+
29+
ci:
30+
name: Build and Test
31+
needs: matrix
32+
if: ${{ always() }}
33+
runs-on: ubuntu-latest
34+
35+
steps:
36+
- run: ${{ needs.matrix.result == 'success' && 'true' || 'false' }}

‎.gitignore‎

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

‎COPYING.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 ian
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.

‎Cargo.lock‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[package]
2+
name = "fiber-sphinx"
3+
version = "0.1.0"
4+
edition = "2021"
5+
6+
[dependencies]

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Fiber Sphinx
2+
3+
A Rust implementation of [Sphinx][] (a.k.a. Onion Message) for [Fiber][].
4+
5+
- [Contributing Guidelines](docs/CONTRIBUTING.md)
6+
- [Development](docs/development.md)
7+
8+
[Sphinx]: http://www.cypherpunks.ca/~iang/pubs/Sphinx_Oakland09.pdf
9+
[Fiber]: https://github.com/nervosnetwork/fiber

‎docs/CONTRIBUTING.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing Guidelines
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Develop with Github
12+
13+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## Pull Requests
16+
17+
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
18+
19+
1. Fork the repo and create your branch from `develop`.
20+
2. If you've added code that should be tested, add tests.
21+
3. If you've changed APIs, update the documentation.
22+
4. Ensure the test suite passes.
23+
5. Make sure your code lints.
24+
6. Use a consistent coding style. Run `cargo fmt` to format your code or setup prettier in your editor.
25+
7. Issue that pull request!
26+
27+
## License
28+
29+
By contributing, you agree that your contributions will be licensed under its MIT License.
30+
31+
## Report bugs using Github's [issues](../../../issues)
32+
33+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](../../../issues/new/choose); it's that easy!

0 commit comments

Comments
 (0)