Skip to content

Commit

Permalink
Merge pull request #7389 from aquaproj/docs/issue-is-unneeded
Browse files Browse the repository at this point in the history
docs: add the description about issue
  • Loading branch information
suzuki-shunsuke committed Oct 26, 2022
2 parents 3b4463d + 3d2624a commit 13944cd
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ Please read the following document.

- https://github.com/suzuki-shunsuke/oss-contribution-guide

## Should you create an Issue before sending a Pull Request?

Basically, you don't have to create an Issue before sending a Pull Request.
But if the pull request requires the discussion before reviewing, you have to create an Issue in advance.

For example, you don't have to create an Issue in the following cases.

- Add a package
- Fix a typo

On the other hand, for example if you want to change the directory structure in `pkgs` or the workflow adding a package,
you have to create an Issue and describe what is changed and why the change is needed.

## Requirements

- [aqua](https://aquaproj.github.io/docs/reference/install) >= [v1.14.0](https://github.com/aquaproj/aqua/releases/tag/v1.14.0)
Expand Down

0 comments on commit 13944cd

Please sign in to comment.