Skip to content

Commit

Permalink
Improve onboarding docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheButlah committed Sep 18, 2023
1 parent 936c06e commit b8fb648
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributors Guide

Thanks for helping out with Nexus!

## Coding guidelines

* Code should compile on all of mac, windows, linux (we will eventually check that in
CI).
* We enforce `cargo fmt` and `cargo clippy` in CI.
* Files should end in newlines.
* Try to keep examples as minimal as possible.
* Be sure to use [our discord](https://discord.gg/VQxSKJUa9F) to keep in touch :)
* Dependencies of your code should not use viral licenses like GPL or LGPL (MPL is
fine) or unlicensed code - if you're not sure, feel free to ask us if the license is
ok.

## License

Unless otherwise specified, all code in this repository is dual-licensed under
either:

- MIT License ([LICENSE-MIT](LICENSE-MIT))
- BSD 2-Clause Plus Patent License ([LICENSE-BSD](LICENSE-BSD))

at your option. This means you can select the license you prefer!

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, shall be dual licensed as above, without any
additional terms or conditions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@ the skills/demos that interest you for instructions on how to run them.
- `direnv allow`
- `git lfs install && git lfs pull`

## Contributions

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

Unless otherwise specified, all code in this repository is dual-licensed under
Expand Down

0 comments on commit b8fb648

Please sign in to comment.