This repository has been archived by the owner on Nov 28, 2020. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 0
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
fa6afe4
commit 9e2ff0a
Showing
1 changed file
with
10 additions
and
19 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,21 +1,12 @@ | ||
## Contribute This Repository | ||
Think this repository is good? You can do something practical-contribute to this repo! | ||
### Report A Good Issue | ||
1. Go to [**Issues**](//github.com/TechPot-Studio/peb.js/issues) | ||
2. Pick a right template | ||
3. State the bug or your suggestion | ||
4. Please confirm before commit | ||
- Whether the content you reported is a bug | ||
- That your suggestion has not been added | ||
- No duplicate issues | ||
|
||
### Make Changes To The Code | ||
1. Fork to your own account | ||
2. Modify code | ||
3. Open the shell and type the following code | ||
```bash | ||
$ npm run minify | ||
``` | ||
Our compression code is based on terser. Please use `npm i -g terser` to install CLI first | ||
4. Submit the code to GitHub | ||
5. Create a new branch and start **Pull Requests** | ||
### Report a bug to us | ||
Go to [Issues](//github.com/TechPot-Studio/peb.js/issues) and select **Bug Report** template, then describe the error you encountered in as much detail as possible. | ||
When you are sure, press the *commit* key. We will check the code and deal with it as soon as possible | ||
### Contribute on code | ||
Fork repository to your account, then merge code directly. | ||
When you are done, don't forget to open the command terminal and enter the following code to minify your changes. | ||
```bash | ||
$ npm run minify | ||
``` | ||
Create a new branch and start pull requests. Fill in the content information you modified clearly |