|
| 1 | +# Contributing in webpack-remove-empty-scripts |
| 2 | + |
| 3 | +- [Questions and Suggestions](#question) |
| 4 | +- [Issues and Bugs](#issue) |
| 5 | +- [Feature Requests](#feature) |
| 6 | +- [Pull Request Submission Guidelines](#submit-pr) |
| 7 | +- [Commit Message Conventions](#commit) |
| 8 | + |
| 9 | +## <a name="question"></a> Got a Question or Suggestion? |
| 10 | + |
| 11 | +If you have questions or suggestions, please create a new [discussion](https://github.com/webdiscus/webpack-remove-empty-scripts/discussions). |
| 12 | + |
| 13 | + |
| 14 | +## <a name="issue"></a> Found an Issue or Bug? |
| 15 | + |
| 16 | +Before you submit an issue, please search the issue tracker, |
| 17 | +maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. |
| 18 | + |
| 19 | +We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. |
| 20 | + |
| 21 | +Tell us versions of your environment: |
| 22 | + |
| 23 | +- OS: macOS, Linux, Windows |
| 24 | +- version of Node.js |
| 25 | +- version of Webpack |
| 26 | +- version of the Plugin |
| 27 | +- the use-case that fails |
| 28 | + |
| 29 | +Ideally create a small repository with a reproducible issue. |
| 30 | + |
| 31 | + |
| 32 | +## <a name="feature"></a> Feature Requests? |
| 33 | + |
| 34 | +You can _request_ a new feature by creating an [issue](https://github.com/webdiscus/webpack-remove-empty-scripts/issues). |
| 35 | + |
| 36 | +The title must begins with `[FEATURE]`. |
| 37 | + |
| 38 | + |
| 39 | +## <a name="submit-pr"></a> Pull Request Submission Guidelines |
| 40 | + |
| 41 | +Before you submit your Pull Request (PR) consider the following guidelines: |
| 42 | + |
| 43 | +- Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). |
| 44 | +- Your PR must have only `one` commit. If you have many commits, please squash all commits into one. |
| 45 | +- Please test your pull request: |
| 46 | + - new/changed code `must` be completely covered, at last `95%` |
| 47 | + - create a new test case under `./test/cases/` directory |
| 48 | + - all already existing tests must be passed: `npm test` |
| 49 | + |
| 50 | + |
| 51 | +## <a name="commit"></a> Commit Conventions |
| 52 | + |
| 53 | +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special |
| 54 | +format that includes a **type**, a **scope** and a **subject**: |
| 55 | + |
| 56 | +``` |
| 57 | +<type>(<scope>): <subject> |
| 58 | +<BLANK LINE> |
| 59 | +<body> |
| 60 | +<BLANK LINE> |
| 61 | +<footer> |
| 62 | +``` |
| 63 | + |
| 64 | +The **header** is mandatory and the **scope** of the header is optional. |
| 65 | + |
| 66 | +Any line of the commit message cannot be longer 100 characters! This allows the message to be easier |
| 67 | +to read on GitHub as well as in various git tools. |
| 68 | + |
| 69 | +The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any. |
| 70 | + |
| 71 | +Examples: |
| 72 | + |
| 73 | +``` |
| 74 | +docs(readme): unpdate usage cases |
| 75 | +``` |
| 76 | + |
| 77 | +``` |
| 78 | +fix: error ... on Windows |
| 79 | +``` |
| 80 | + |
| 81 | +### Type |
| 82 | + |
| 83 | +Must be one of the following: |
| 84 | + |
| 85 | +- **chore**: changes that fall outside of build / docs that do not effect source code (example scopes: package, defaults) |
| 86 | +- **docs**: documentation only changes (example scopes: readme, changelog) |
| 87 | +- **feat**: a new feature |
| 88 | +- **fix**: a bug fix |
| 89 | +- **perf**: a code change that improves performance |
| 90 | +- **refactor**: a code change that neither fixes a bug nor adds a feature |
| 91 | +- **style**: changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons) |
| 92 | +- **test**: addition of or updates to Jest tests |
| 93 | + |
| 94 | +### Scope |
| 95 | + |
| 96 | +The scope is subjective & depends on the `type` see above. A good example would be a change to a particular class / module. |
| 97 | + |
| 98 | +### Subject |
| 99 | + |
| 100 | +The subject contains a succinct description of the change: |
| 101 | + |
| 102 | +- use the imperative, present tense: "change" not "changed" nor "changes" |
| 103 | +- don't capitalize the first letter |
| 104 | +- no dot (.) at the end |
| 105 | + |
| 106 | +### Body |
| 107 | + |
| 108 | +Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". |
| 109 | +The body should include the description of the change. |
| 110 | + |
| 111 | +### Footer |
| 112 | + |
| 113 | +The footer should contain the reference GitHub issues that this commit **Closes**. |
0 commit comments