-
Notifications
You must be signed in to change notification settings - Fork 311
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
77d2018
commit a9c903d
Showing
1 changed file
with
42 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,55 @@ | ||
| # Contributing to Slash libraries | ||
|
|
||
| We welcome contribution from everyone in the community. | ||
| > Every contributor to Slash libraries should adhere to our Code of Conduct. | ||
| > <br/>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: | ||
|
|
||
| - Improving our [docs](https://slash.page) | ||
| - [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) <br/> | ||
| You can raise your own PR. The title of your PR should match the following format: | ||
|
|
||
| ``` | ||
| <type>[package scope]: <description> | ||
| ``` | ||
|
|
||
| > We do not care about the number, or style of commits in your history, because we squash merge every PR into main. <br/> | ||
| > 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)<br/> | ||
| 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. | ||
|
|
||
|
|
||
|
|