Skip to content

Commit

Permalink
docs(contributing): Add more information for contributors (#60)
Browse files Browse the repository at this point in the history
Make it easy to understand how to contribute.
  • Loading branch information
5ouma authored Mar 19, 2024
1 parent a5084d1 commit 29e7f7d
Showing 1 changed file with 40 additions and 6 deletions.
46 changes: 40 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,34 @@ I would recommend reading this guideline for a better development experience.

<br />

- [πŸ”  Branch Prefix](#-branch-prefix)
- [πŸ§ͺ Testing Advice](#-testing-advice)
- [πŸ’¬ Commit Message](#-commit-message)
- [πŸ”  Branch Prefix](#-branch-prefix)
- [❓ Pull Requests Title](#-pull-requests-title)
- [πŸͺ΅ Commit Log](#-commit-log)

<br /><br />

## πŸ§ͺ Testing Advice

There is a test function called [`Test_OAScript`](../lib/oascript_test.go)
for AppleScript commands.<br />
When you run this test, your Login Items all will be removed.
Therefore, I highly recommend backing up your current Login Items by `mli save`.

<br />

## πŸ’¬ Commit Message

I recommend you to follow [Conventional Commits] with this format.

```commit message
type(scope): Description
Body
```

[Conventional Commits]: https://www.conventionalcommits.org

<br />

Expand Down Expand Up @@ -38,9 +64,17 @@ For the details of each label, please see [Labels](https://github.com/5ouma/mli/

> Labels were generated with [@azu / github-label-setup](https://github.com/azu/github-label-setup)
## πŸ§ͺ Testing Advice
<br />

There is a test function called [`Test_OAScript`](../lib/oascript_test.go)
for AppleScript commands.<br />
When you run this test, your Login Items all will be removed.
Therefore, I highly recommend backing up your current Login Items by `mli save`.
## ❓ Pull Requests Title

You don't need to add any prefixes like `feature` or `bug fix`
to the Pull Requests title because I can recognize what kind of PR it is from labels.
Please give a clear title.

<br />

## πŸͺ΅ Commit Log

I do squash merge to the main branch to keep the commit history clean.
When merging your Pull Request, I'll add the Conventional Commits type and scope.

0 comments on commit 29e7f7d

Please sign in to comment.