mirror of
https://github.com/Hopiu/lychee.git
synced 2026-04-11 00:40:58 +00:00
27 lines
887 B
Markdown
27 lines
887 B
Markdown
# Contributing to lychee
|
|
|
|
## Getting Started
|
|
|
|
Lychee is written in Rust. Install [rust-up](https://rustup.rs/) to get started.
|
|
Begin by making sure the following commands succeed without errors.
|
|
|
|
```sh
|
|
cargo test # runs tests
|
|
cargo clippy # lints code
|
|
```
|
|
|
|
## Picking an Issue
|
|
|
|
We try to keep the issue-tracker up-to-date so you can quickly find a task to work on.
|
|
|
|
Try one of these links to get started:
|
|
|
|
- [good first issues](https://github.com/lycheeverse/lychee/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
|
- [help wanted](https://github.com/lycheeverse/lychee/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
|
|
|
|
If you would like to contribute a new feature, the best way to get started is to
|
|
ask for some early feedback by creating an issue yourself and asking for feedback.
|
|
|
|
## Thanks!
|
|
|
|
No matter how small, we appreciate very contribution. You're awesome!
|