Thanks for wanting to contribute to Papers! We are very much looking forward to your suggestions, bug reports, and pull requests.
Have a look at our [issue tracker](https://github.com/store2be/pape-rs/issues. If you can't find an issue (open or closed) describing your problem (or a very similar one) there, please open a issue with the following details:
- Which versions of Rust and Papers are you using?
- What are you trying to accomplish?
- What is the full error you are seeing?
- How can we reproduce this?
- Please quote as much of your code as needed to reproduce (best link to a public repository or a Gist)
Thank you! We'll try to get back to you as soon as possible.
If you can't find an issue (open or closed) describing your idea on our issue tracker, open an issue. It would be great if you could answer the following questions in your description:
- What do you want to do and how do you expect Papers to support you with that?
- How do you think this can be added to Papers?
- What are possible alternatives?
- Are there any disadvantages?
Thank you! We'll try to get back to you as soon as possible.
- Install Rust using rustup, which allows you to easily switch between Rust versions.
- Clone this repository.
- Now, try running the test suite to confirm everything works for you locally
by executing
cargo test. (Initially, this will take a while to compile everything.)
We use gitmojis for our commit messages. It would be cool if you adapt this when contributing to Papers.
All submissions, including submissions by project members, require review. We use Github pull requests for this purpose.
We follow the Rust Code of Conduct.