| 1 | # Contributing in @webpack-contrib
|
| 2 |
|
| 3 | We'd always love contributions to further improve the webpack / webpack-contrib ecosystem!
|
| 4 | Here are the guidelines we'd like you to follow:
|
| 5 |
|
| 6 | - [Questions and Problems](#question)
|
| 7 | - [Issues and Bugs](#issue)
|
| 8 | - [Feature Requests](#feature)
|
| 9 | - [Pull Request Submission Guidelines](#submit-pr)
|
| 10 | - [Commit Message Conventions](#commit)
|
| 11 |
|
| 12 | ## <a name="question"></a> Got a Question or Problem?
|
| 13 |
|
| 14 | Please submit support requests and questions to StackOverflow using the tag [[webpack]](http://stackoverflow.com/tags/webpack).
|
| 15 | StackOverflow is better suited for this kind of support though you may also inquire in [Webpack Gitter](https://gitter.im/webpack/webpack).
|
| 16 | The issue tracker is for bug reports and feature discussions.
|
| 17 |
|
| 18 | ## <a name="issue"></a> Found an Issue or Bug?
|
| 19 |
|
| 20 | Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
|
| 21 |
|
| 22 | We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we ask that you to provide a minimal reproduction scenario (github repo or failing test case). Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like:
|
| 23 |
|
| 24 | - version of Webpack used
|
| 25 | - version of the loader / plugin you are creating a bug report for
|
| 26 | - the use-case that fails
|
| 27 |
|
| 28 | A minimal reproduce scenario allows us to quickly confirm a bug (or point out config problems) as well as confirm that we are fixing the right problem.
|
| 29 |
|
| 30 | We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
|
| 31 |
|
| 32 | Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.
|
| 33 |
|
| 34 | ## <a name="feature"></a> Feature Requests?
|
| 35 |
|
| 36 | You can _request_ a new feature by creating an issue on Github.
|
| 37 |
|
| 38 | If you would like to _implement_ a new feature, please submit an issue with a proposal for your work `first`, to be sure that particular makes sense for the project.
|
| 39 |
|
| 40 | ## <a name="submit-pr"></a> Pull Request Submission Guidelines
|
| 41 |
|
| 42 | Before you submit your Pull Request (PR) consider the following guidelines:
|
| 43 |
|
| 44 | - Search Github for an open or closed PR that relates to your submission. You don't want to duplicate effort.
|
| 45 | - Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages.
|
| 46 | - Fill out our `Pull Request Template`. Your pull request will not be considered if it is ignored.
|
| 47 | - Please sign the `Contributor License Agreement (CLA)` when a pull request is opened. We cannot accept your pull request without this. Make sure you sign with the primary email address associated with your local / github account.
|
| 48 |
|
| 49 | ## <a name="commit"></a> Webpack Contrib Commit Conventions
|
| 50 |
|
| 51 | Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
|
| 52 | format that includes a **type**, a **scope** and a **subject**:
|
| 53 |
|
| 54 | ```
|
| 55 | <type>(<scope>): <subject>
|
| 56 | <BLANK LINE>
|
| 57 | <body>
|
| 58 | <BLANK LINE>
|
| 59 | <footer>
|
| 60 | ```
|
| 61 |
|
| 62 | The **header** is mandatory and the **scope** of the header is optional.
|
| 63 |
|
| 64 | Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
|
| 65 | to read on GitHub as well as in various git tools.
|
| 66 |
|
| 67 | The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
|
| 68 |
|
| 69 | Examples:
|
| 70 |
|
| 71 | ```
|
| 72 | docs(readme): update install instructions
|
| 73 | ```
|
| 74 |
|
| 75 | ```
|
| 76 | fix: refer to the `entrypoint` instead of the first `module`
|
| 77 | ```
|
| 78 |
|
| 79 | ### Revert
|
| 80 |
|
| 81 | If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit.
|
| 82 | In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
|
| 83 |
|
| 84 | ### Type
|
| 85 |
|
| 86 | Must be one of the following:
|
| 87 |
|
| 88 | - **build**: Changes that affect the build system or external dependencies (example scopes: babel, npm)
|
| 89 | - **chore**: Changes that fall outside of build / docs that do not effect source code (example scopes: package, defaults)
|
| 90 | - **ci**: Changes to our CI configuration files and scripts (example scopes: circleci, travis)
|
| 91 | - **docs**: Documentation only changes (example scopes: readme, changelog)
|
| 92 | - **feat**: A new feature
|
| 93 | - **fix**: A bug fix
|
| 94 | - **perf**: A code change that improves performance
|
| 95 | - **refactor**: A code change that neither fixes a bug nor adds a feature
|
| 96 | - **revert**: Used when reverting a committed change
|
| 97 | - **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
|
| 98 | - **test**: Addition of or updates to Jest tests
|
| 99 |
|
| 100 | ### Scope
|
| 101 |
|
| 102 | The scope is subjective & depends on the `type` see above. A good example would be a change to a particular class / module.
|
| 103 |
|
| 104 | ### Subject
|
| 105 |
|
| 106 | The subject contains a succinct description of the change:
|
| 107 |
|
| 108 | - use the imperative, present tense: "change" not "changed" nor "changes"
|
| 109 | - don't capitalize the first letter
|
| 110 | - no dot (.) at the end
|
| 111 |
|
| 112 | ### Body
|
| 113 |
|
| 114 | Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
|
| 115 | The body should include the motivation for the change and contrast this with previous behavior.
|
| 116 |
|
| 117 | ### Footer
|
| 118 |
|
| 119 | The footer should contain any information about **Breaking Changes** and is also the place to
|
| 120 | reference GitHub issues that this commit **Closes**.
|
| 121 |
|
| 122 | **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
| 123 |
|
| 124 | Example
|
| 125 |
|
| 126 | ```
|
| 127 | BREAKING CHANGE: Updates to `Chunk.mapModules`.
|
| 128 |
|
| 129 | This release is not backwards compatible with `Webpack 2.x` due to breaking changes in webpack/webpack#4764
|
| 130 | Migration: see webpack/webpack#5225
|
| 131 |
|
| 132 | ```
|
| 133 |
|
| 134 | ## Testing Your Pull Request
|
| 135 |
|
| 136 | You may have the need to test your changes in a real-world project or dependent
|
| 137 | module. Thankfully, Github provides a means to do this. Add a dependency to the
|
| 138 | `package.json` for such a project as follows:
|
| 139 |
|
| 140 | ```json
|
| 141 | {
|
| 142 | "devDependencies": {
|
| 143 | "${package}": "${repo}#{id}/head"
|
| 144 | }
|
| 145 | }
|
| 146 | ```
|
| 147 |
|
| 148 | Where `{id}` is the # ID of your Pull Request.
|
| 149 |
|
| 150 | ## Contributor License Agreement
|
| 151 |
|
| 152 | When submitting your contribution, a CLA (Contributor License Agreement) bot will come by to verify that you signed the [CLA](https://cla.js.foundation/${repo}).
|
| 153 | If it is your first time, it will link you to the right place to sign it.
|
| 154 | However, if you have committed your contributions using an email that is not the same as your email used on GitHub, the CLA bot can't accept your contribution.
|
| 155 |
|
| 156 | Run `git config user.email` to see your Git email, and verify it with [your GitHub email](https://github.com/settings/emails).
|
| 157 |
|
| 158 | ## Thanks
|
| 159 |
|
| 160 | For your interest, time, understanding, and for following this simple guide.
|