Skip to content

Add CONTRIBUTING.md #4

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.

Sign up for GitHub

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

Draft
lambdalisue wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add CONTRIBUTING.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing to this repository

## Getting started

Before you begin:

- Have you read the [code of conduct](./CODE_OF_CONDUCT.md)?

## Reviewing

We often use **must**, _should_, or may as a leveling label of comments.

**must**

What reviewer think you must fix. For example

![must The unit of responseTimeout is milliseconds rather than seconds.](https://user-images.githubusercontent.com/546312/127770085-fec9053b-1291-4728-854e-0ccf7c3f44d5.png)

_should_

What reviewer think you should fix or want reasonable explanations. For example

![should Why do you choose 7 days for that? I think it's too long for response timeout and maybe 24 hours is enough.](https://user-images.githubusercontent.com/546312/127770162-bdd5b421-bde4-446c-82cb-01aa7ec3504a.png)

may

What reviewer feel not good or strange. It's more like advice and you can
ignore. For example

![may I feel responseTimeoutSeconds is a bit better than responseTimeout because it tells the unit of the value.](https://user-images.githubusercontent.com/546312/127770316-996b5b62-7aba-48b6-b558-3b4fa30f1c1b.png)