|
| 1 | +# Welcome to SQL! |
| 2 | + |
| 3 | +Please take a second to read over this before opening an issue. Providing complete information upfront will help us address any issue (and ship new features!) faster. |
| 4 | + |
| 5 | +We greatly appreciate bug fixes, documentation improvements and new features, however when contributing a new major feature, it is a good idea to idea to first open an issue, to make sure the feature it fits with the goal of the project, so we don't waste your or our time. |
| 6 | + |
| 7 | +## Bug Reports |
| 8 | + |
| 9 | +A perfect bug report would have the following: |
| 10 | + |
| 11 | +1. Summary of the issue you are experiencing. |
| 12 | +2. Details on what versions of node you have (`node -v`). |
| 13 | +3. A simple repeatable test case for us to run. Please try to run through it 2-3 times to ensure it is completely repeatable. |
| 14 | + |
| 15 | +We would like to avoid issues that require a follow up questions to identify the bug. These follow ups are difficult to do unless we have a repeatable test case. |
| 16 | + |
| 17 | +## For Developers |
| 18 | + |
| 19 | +All constributings should fit the [standard](https://github.com/standard/standard) linter, and pass the tests. |
| 20 | +You can test this by running: |
| 21 | + |
| 22 | +``` |
| 23 | +npm test |
| 24 | +``` |
| 25 | + |
| 26 | +In addition, make sure to add tests for any new features. |
| 27 | +You can test the test coverage by running: |
| 28 | + |
| 29 | +``` |
| 30 | +npm run coverage |
| 31 | +``` |
| 32 | + |
| 33 | +## For Collaborators |
| 34 | + |
| 35 | +Make sure to get a `:thumbsup:`, `+1` or `LGTM` from another collaborator before merging a PR. If you aren't sure if a release should happen, open an issue. |
| 36 | + |
| 37 | +Release process: |
| 38 | + |
| 39 | +- `npm test` |
| 40 | +- `npm version <major|minor|patch>` |
| 41 | +- `git push && git push --tags` |
| 42 | +- `npm publish` |
| 43 | + |
| 44 | +----------------------------------------- |
| 45 | + |
| 46 | +<a id="developers-certificate-of-origin"></a> |
| 47 | +## Developer's Certificate of Origin 1.1 |
| 48 | + |
| 49 | +By making a contribution to this project, I certify that: |
| 50 | + |
| 51 | +* (a) The contribution was created in whole or in part by me and I |
| 52 | + have the right to submit it under the open source license |
| 53 | + indicated in the file; or |
| 54 | + |
| 55 | +* (b) The contribution is based upon previous work that, to the best |
| 56 | + of my knowledge, is covered under an appropriate open source |
| 57 | + license and I have the right under that license to submit that |
| 58 | + work with modifications, whether created in whole or in part |
| 59 | + by me, under the same open source license (unless I am |
| 60 | + permitted to submit under a different license), as indicated |
| 61 | + in the file; or |
| 62 | + |
| 63 | +* (c) The contribution was provided directly to me by some other |
| 64 | + person who certified (a), (b) or (c) and I have not modified |
| 65 | + it. |
| 66 | + |
| 67 | +* (d) I understand and agree that this project and the contribution |
| 68 | + are public and that a record of the contribution (including all |
| 69 | + personal information I submit with it, including my sign-off) is |
| 70 | + maintained indefinitely and may be redistributed consistent with |
| 71 | + this project or the open source license(s) involved. |
0 commit comments