mirror/tea
1
1
Fork 0
mirror of https://gitea.com/gitea/tea synced 2024-11-23 00:12:05 +01:00
Code Issues

Fix few typos in contribution guidelines (#459)

Browse Source 
I found few typos in `CONTRIBUTING.md` file.

Co-authored-by: Petr Vaněk <arkamar@atlas.cz>
Reviewed-on: https://gitea.com/gitea/tea/pulls/459
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: 6543 <6543@obermui.de>
Co-authored-by: arkamar <arkamar@noreply.gitea.io>
Co-committed-by: arkamar <arkamar@noreply.gitea.io>
This commit is contained in:
arkamar 2022-02-22 22:34:58 +08:00 committed by 6543
parent dd300c1269
commit cd24fd8e28
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -57,8 +57,8 @@ high-level discussions.
## Testing redux ## Testing redux
Before sending code out for review, run all the test by execting: `make test` Before sending code out for review, run all the test by executing: `make test`
Since TEA is an cli tool it should be obvious to test your feature localy first. Since TEA is an cli tool it should be obvious to test your feature locally first.
## Vendoring ## Vendoring
@ -77,7 +77,7 @@ You can find more information on how to get started with it on the [dep project
## Code review ## Code review
Changes to TEA must be reviewed before they are accepted—no matter who Changes to TEA must be reviewed before they are accepted—no matter who
makes the change, even if they are an owner or a maintainer. We use Giteas's makes the change, even if they are an owner or a maintainer. We use Gitea's
pull request & review workflow to do that. Gitea ensure every PR is reviewed by at least 2 maintainers. pull request & review workflow to do that. Gitea ensure every PR is reviewed by at least 2 maintainers.
Please try to make your pull request easy to review for us. And, please read Please try to make your pull request easy to review for us. And, please read
@ -118,8 +118,8 @@ Some of the key points:
- Always make sure that the help texts are properly set, and as concise as possible. - Always make sure that the help texts are properly set, and as concise as possible.
### Internal Module Structure ### Internal Module Structure
- `cmd`: only contains comand/flag options for `urfave/cli` - `cmd`: only contains command/flag options for `urfave/cli`
- subcomands are in a subpackage named after its parent comand - subcommands are in a subpackage named after its parent command
- `modules/task`: contain func for doing something with gitea - `modules/task`: contain func for doing something with gitea
(e.g. create token by user/passwd) (e.g. create token by user/passwd)
- `modules/print`: contain all functions that print to stdout - `modules/print`: contain all functions that print to stdout