diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c8398c682..3f46d9177 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,8 +1,11 @@ # Contributing to Slash libraries We welcome contribution from everyone in the community. +> Every contributor to Slash libraries should adhere to our Code of Conduct. +>
Please read the [full text](./CODE_OF_CONDUCT.md) to understand what actions will and will not be tolerated. -## How to contribute + +## 1. Issues You can contribute to Slash libraries via: @@ -10,8 +13,43 @@ You can contribute to Slash libraries via: - [Reporting a bug in our issues tab](https://github.com/toss/slash/issues/new/choose) - [Requesting a new feature or package](https://github.com/toss/slash/issues/new/choose) - [Having a look at our issue list](https://github.com/toss/slash/issues) to see what's to be fixed -- [Opening a pull request](https://github.com/toss/slash/compare) by yourself -## [Code of conduct](./CODE_OF_CONDUCT.md) -Every contributor to Slash libraries should adhere to our Code of Conduct. Please read the [full text](./CODE_OF_CONDUCT.md) to understand what actions will and will not be tolerated. +## 2. Pull Requests +> [Opening a pull request](https://github.com/toss/slash/compare)
+ +You can raise your own PR. The title of your PR should match the following format: + +``` +[package scope]: +``` + +> We do not care about the number, or style of commits in your history, because we squash merge every PR into main.
+> Feel free to commit in whatever style you feel comfortable with. + +### 2.1 Type + +**Type must be one of those** + +if you changed shipped code : +- feat - for any new functionality additions +- fix - for any fixes that don't add new functionality + +if you haven't changed shipped code : +- docs - if you only change documentation +- test - if you only change tests + +other : +- chore - anything else + +### 2.2 Package Scope + +The name of package that you made changes. (ex: react, use-overlay, ky)
+If you made changes across multiple packages, writing package scope is optional. + +### 2.3 Description + +A clear and concise description of what the pr is about. + + +