|
1 | | -## TODO |
| 1 | +## How To Contribute |
| 2 | + |
| 3 | +We are always very happy to have contributions, whether for trivial cleanups or big new features. We want to have high quality, well documented codes for Node.js client SDK. |
| 4 | + |
| 5 | +Nor is code the only way to contribute to the project. We strongly value documentation, integration with other project, and gladly accept improvements for these aspects. |
| 6 | + |
| 7 | +## Submission Guidelines |
| 8 | + |
| 9 | +### Submitting an Issue |
| 10 | + |
| 11 | +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. |
| 12 | + |
| 13 | +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 will systematically ask you to provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions. |
| 14 | + |
| 15 | +A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. |
| 16 | + |
| 17 | +We will be insisting on a minimal reproduction scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger code-base but we really need to isolate the problem before we can fix it. |
| 18 | + |
| 19 | +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. |
| 20 | + |
| 21 | +### Submitting a Pull Request (PR) |
| 22 | + |
| 23 | +Before you submit your Pull Request (PR) consider the following guidelines: |
| 24 | + |
| 25 | +1. Search [GitHub](https://github.com/apache/rocketmq-client-nodejs/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort. |
| 26 | +2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work. |
| 27 | +3. Fork the apache/rocketmq-client-nodejs repo. |
| 28 | +4. Make your changes in a new git branch: |
| 29 | + ``` |
| 30 | + $ git checkout -b your-fix-branch master |
| 31 | + ``` |
| 32 | +5. Create your patch, **including appropriate test cases.** |
| 33 | +6. Follow our [Coding Rules](#rules). |
| 34 | +7. Run the full test suite and ensure that all tests passes. |
| 35 | +8. Commit your changes using a descriptive commit message that follows our commit message conventions. |
| 36 | + ``` |
| 37 | + $ git commit -a |
| 38 | + ``` |
| 39 | +9. Push your branch to GitHub: |
| 40 | + ``` |
| 41 | + $ git push origin your-fix-branch |
| 42 | + ``` |
| 43 | +10. In GitHub, send a pull request to `rocketmq-client-nodejs:master`. |
| 44 | + + If we suggest changes then: |
| 45 | + - Make the required updates. |
| 46 | + - Re-run the test suites to ensure tests are still passing. |
| 47 | +
|
| 48 | +That's all. Thanks for contributing! |
| 49 | +
|
| 50 | +### Coding Rules |
| 51 | +
|
| 52 | +To ensure consistency throughout the source code, keep these rules in mind as you are working: |
| 53 | +
|
| 54 | ++ All features or bug fixes must be tested by one or more specs (unit-tests). |
| 55 | ++ We follow [eslint-config-rocketmq-style](https://www.npmjs.com/package/eslint-config-rocketmq-style) for ESLint. |
| 56 | +
|
| 57 | +### Commit Message Guidelines |
| 58 | +
|
| 59 | +Our commit message is inspired from [Angular's Commit Message Format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines). |
| 60 | +
|
| 61 | +#### Commit Message Format |
| 62 | +
|
| 63 | +Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject: |
| 64 | +
|
| 65 | +``` |
| 66 | +<type>(<scope>): <subject> |
| 67 | +<BLANK LINE> |
| 68 | +<body> |
| 69 | +<BLANK LINE> |
| 70 | +<footer> |
| 71 | +``` |
| 72 | +
|
| 73 | +The **header** is mandatory and the **scope** of the header is optional. |
| 74 | +
|
| 75 | +Any line of the commit message cannot be longer 72 characters! This allows the message to be easier to read on GitHub as well as in various git tools. |
| 76 | +
|
| 77 | +The footer should contain a [closing reference](https://help.github.com/articles/closing-issues-using-keywords/) to an issue if any. |
| 78 | +
|
| 79 | +Samples: |
| 80 | +
|
| 81 | +``` |
| 82 | +chore(package): bump version to 1.0.0. |
| 83 | + |
| 84 | +Close #123 |
| 85 | +``` |
| 86 | +
|
| 87 | +##### Type |
| 88 | +
|
| 89 | +Must be one of the following: |
| 90 | +
|
| 91 | ++ **chore**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| 92 | ++ **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| 93 | ++ **docs**: Documentation only changes |
| 94 | ++ **feat**: A new feature |
| 95 | ++ **fix**: A bug fix |
| 96 | ++ **perf**: A code change that improves performance |
| 97 | ++ **refactor**: A code change that neither fixes a bug nor adds a feature |
| 98 | ++ **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| 99 | ++ **test**: Adding missing tests or correcting existing tests |
0 commit comments