forked from serai-dex/serai
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from TheArchitect108/develop
merge from tip
- Loading branch information
Showing
79 changed files
with
3,186 additions
and
915 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Contributing | ||
|
||
Contributions come in a variety of forms. Developing Serai, helping document it, | ||
using its libraries in another project, using and testing it, and simply sharing | ||
it are all valuable ways of contributing. | ||
|
||
This document will specifically focus on contributions to this repository in the | ||
form of code and documentation. | ||
|
||
### Rules | ||
|
||
- Stable native Rust, nightly wasm and tools. | ||
- `cargo fmt` must be used. | ||
- `cargo clippy` must pass, except for the ignored rules (`type_complexity` and | ||
`dead_code`). | ||
- The CI must pass. | ||
|
||
- Only use uppercase variable names when relevant to cryptography. | ||
|
||
- Put a space after comment markers. | ||
- Don't use multiple newlines between sections of code. | ||
- Have a newline before EOF. | ||
|
||
### Guidelines | ||
|
||
- Sort inputs as core, std, third party, and then Serai. | ||
- Comment code reasonably. | ||
- Include tests for new features. | ||
- Sign commits. | ||
|
||
### Submission | ||
|
||
All submissions should be through GitHub. Contributions to a crate will be | ||
licensed according to the crate's existing license, with the crate's copyright | ||
holders (distinct from authors) having the right to re-license the crate via a | ||
unanimous decision. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Serai crates are licensed under one of two licenses, either MIT or AGPL-3.0, | ||
depending on the crate in question. Each crate declares their license in their | ||
`Cargo.toml` and includes a `LICENSE` file detailing its status. Additionally, | ||
a full copy of the AGPL-3.0 License is included in the root of this repository | ||
as a reference text. This copy should be provided with any distribution of a | ||
crate licensed under the AGPL-3.0, as per its terms. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.