Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

25 lines (18 loc) · 1.72 KB
Raw

Contributing

Since Finshir is a free (in sense of freedom) kind of software, you are always welcome to contribute! Please look through our code of conduct and the liberal GPLv3 license, under which the product is distributed.

Environment setup

To setup your development environment for contribution, you need to install the Rust toolchain using one convenient command below:

# Setup all the rust programming language toolchain
curl https://sh.rustup.rs -sSf | sh

We use the IntelliJ Rust integrated development environment for comfortable development process. Just install it from the link above (or download this plugin) and open the cloned repository using it.

Building and testing

As it should be in correct projects, all the building and testing procedures are performed by Travis CI. But, of course, you can do it by yourself using the following commands:

$ cargo build --verbose --all
$ cargo test --verbose --all

Where to go?

  • Issues are meant for reporting found bugs and new functionality suggestions. Discussions are welcome too, and I will try to answer you in near future.

  • Pulls are meant for implementing new functionality and fixing bugs. Note that other people can criticize your code, and you should answer them. Also don't forget to run cargo fmt before pushing any changes.