-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
03ffc3a
commit a55b4d2
Showing
1 changed file
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
# Contribution guidelines | ||
|
||
First off, thank you for considering contributing to Ducker. | ||
|
||
If your contribution is not straightforward, please first discuss the change you wish to make by | ||
creating a new issue before making the change. | ||
|
||
## Reporting issues | ||
|
||
Before reporting an issue on the [issue tracker](https://github.com/robertpsoane/ducker/issues), | ||
please check that it has not already been reported by searching for some related keywords. | ||
|
||
## Pull requests | ||
|
||
Try to do one pull request per change. | ||
|
||
## Commit Message Format | ||
|
||
This project adheres to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). | ||
A specification for adding human and machine readable meaning to commit messages. | ||
|
||
### Commit Message Header | ||
|
||
```plain | ||
<type>(<scope>): <short summary> | ||
β β β | ||
β β βββ«Έ Summary in present tense. Not capitalized. No period at the end. | ||
β β | ||
β βββ«Έ Commit Scope | ||
β | ||
βββ«Έ Commit Type: feat|fix|build|ci|docs|perf|refactor|test|chore | ||
``` | ||
|
||
#### Type | ||
|
||
| feat | Features | A new feature | | ||
| --------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------- | | ||
| fix | Bug Fixes | A bug fix | | ||
| docs | Documentation | Documentation only changes | | ||
| style | Styles | Changes that do not affect the meaning of the code\ | | ||
| (white-space, formatting, missing semi-colons, etc) | | ||
| refactor | Code Refactoring | A code change that neither fixes a bug nor adds a feature | | ||
| perf | Performance Improvements | A code change that improves performance | | ||
| test | Tests | Adding missing tests or correcting existing tests | | ||
| build | Builds | Changes that affect the build system or external dependencies (example scopes: main, serde) | | ||
| ci | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Github Actions) | | ||
| chore | Chores | Other changes that don't modify src or test files | | ||
| revert | Reverts | Reverts a previous commit | | ||
|
||
## Developing | ||
|
||
### Set up | ||
|
||
|
||
```shell | ||
git clone https://github.com/robertpsoane/ducker | ||
cd ducker | ||
``` | ||
|
||
### Useful Commands | ||
|
||
- Run Clippy: | ||
|
||
```shell | ||
cargo clippy --all-targets --all-features --workspace | ||
``` | ||
|
||
|
||
- Check to see if there are code formatting issues | ||
|
||
```shell | ||
cargo fmt --all -- --check | ||
``` | ||
|
||
- Format the code in the project | ||
|
||
```shell | ||
cargo fmt --all | ||
``` | ||
|
||
(based on [joshka/ratatui-widgets/CONTRIBUTING.md](https://github.com/joshka/ratatui-widgets/tree/main)) |