Skip to content
This repository was archived by the owner on Jan 3, 2024. It is now read-only.

Create CONTRIBUTING.md #8

Merged
merged 2 commits into from
Mar 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing

Thank you for contributing! It's very appreciated. ♥️
Please verify that you can check the following boxes.

## Before opening a PR

- [ ] The PR has a defined scope, it changes one thing (and not any unrelated other)
- [ ] If it is a bug fix, there is an opened issue<sup>1</sup>

<sup>1</sup> If no issue exists about the bug, don't hesitate to open one~

## Once the PR is opened

- [ ] If it is a bug fix, you tagged the related issue in the PR title<sup>2</sup>
- [ ] If needed, you wrote the reasons of your change(s) in the PR description
- [ ] The Rust GHA workflow status passes<sup>3</sup>

<sup>2</sup> The recommended formatting is: `GH-XXX: <title>` with `XXX` being the issue number.
<sup>3</sup> The pre-commit CI status does not have to pass, but it's better if it does 💕

### Suggested, but not enforced:

- [ ] The changes you made are in a separate branch (i.e. not your fork's `main`)

## Once the PR is merged

Thank you again~ Your contribution is very valuable.
You can now delete your branch safely. 😄

## My PR got closed...

We cherish your willingness to participate to the project!
Perhaps your PR did not meet the requirements or another path was chosen.

Don't get discouraged! Your future PRs will be looked at in detail and one of them might get merged~

**Happy coding~**