-
Notifications
You must be signed in to change notification settings - Fork 142
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cf89630
commit 5f6a44b
Showing
1 changed file
with
14 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Contributing to Feather | ||
|
||
Feather is an ambitious project, and contributions are always welcome! | ||
|
||
If you want to work on the codebase, please keep the following in mind: | ||
* Run `rustfmt` on your code before committing. The CI build will fail if rustfmt detects formatting errors. | ||
* Run [`clippy`](https://github.com/rust-lang/rust-clippy) on your code and fix any warnings it gives. Clippy can detect common mistakes, and as with formatting, the build will fail if there are Clippy warnings. | ||
* Where possible and necessary, please write tests. | ||
* Run `cargo test` before committing to ensure you have not broken anything. | ||
|
||
Also, please do not write code that is in any way inspired, based on, or taken from Mojang's work, including but not limited to | ||
the vanilla server and client. Feather is a "clean-room" implementation, meaning that it is written | ||
from scratch without any involvement with proprietary code. By using code from Mojang, the project | ||
would become prone to legal issues. |