Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[github] add pr template and CONTRIBUTING.md #212

Merged
merged 2 commits into from
Jul 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# How to contribute

Thanks for reading this document!

## Prerequisites
- Rust (e.g. via `rustup install stable`)
- Cargo (with `fmt`, `clippy` and `nextest`):
- `rustup component add rustfmt`
- `rustup component add clippy`
- `cargo install nextest`

## Code style
Before you create a PR, just run `check.sh`:
- This will format your code via `fmt`
- Runs the linter `clippy`
- Runs all tests via `nextest`

## Good first issues
If you want to contribute, but don't feel ready for the big tasks, feel free to choose from one of our [good first issues](https://github.com/comtrya/comtrya/issues?q=is%3Aissue+is%3Aopen+label%3AMeta%3A%3AGoodFirstIssue)

## Pull requests
We provide a [pull request template](https://github.com/comtrya/comtrya/docs/pull_request_template.md) to guide you through the progress.

## Help
If you want to get in touch with us, join the [Rawkode Academy Discord](https://rawkode.chat/) server and jump into the `#comtrya` channel.

> See You Space Cowboy...
17 changes: 17 additions & 0 deletions docs/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## I'm submitting a

- [ ] bug fix
- [ ] feature

## What is the current behaviour?

## If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

## What is the expected behavior?

## What is the motivation / use case for changing the behavior?

## Please tell us about your environment:

Version (`comtrya --version`):
Operating system: