mirror of
https://github.com/GothenburgBitFactory/taskchampion-sync-server.git
synced 2025-06-26 10:54:29 +02:00
20 lines
1,011 B
Markdown
20 lines
1,011 B
Markdown
# Welcome
|
|
|
|
TaskChampion sync-server is very open to contributions, and we'd love to have your help!
|
|
|
|
A good starting point might be one of the issues tagged with ["good first issue"][first].
|
|
|
|
[first]: https://github.com/GothenburgBitFactory/taskchampion-sync-server/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
|
|
|
|
# Development Guide
|
|
|
|
This repository is a typical Rust application.
|
|
To work on it, you'll need to [install a recent version of Rust](https://www.rust-lang.org/tools/install) (the latest stable is always a good choice).
|
|
Once you've done that, run `cargo build` at the top level of this repository to build the binary.
|
|
Alternately, run `cargo test` to run the test suite.
|
|
|
|
## Making a Pull Request
|
|
|
|
We expect contributors to follow the [GitHub Flow](https://guides.github.com/introduction/flow/).
|
|
Aside from that, we have no particular requirements on pull requests.
|
|
Make your patch, double-check that it's complete (tests? docs? documentation comments?), and make a new pull request.
|