1 | # Welcome to Clinic.js!
|
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 | ## Code of Conduct
|
8 |
|
9 | The Clinic.js project has a [Code of Conduct][CoC] that all contributors are
|
10 | expected to follow.
|
11 |
|
12 | ## Bug Reports
|
13 |
|
14 | A perfect bug report would have the following:
|
15 |
|
16 | 1. Summary of the issue you are experiencing.
|
17 | 2. Details on what versions of node and Clinic.js you have (`node -v` and `clinic -v`).
|
18 | 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.
|
19 |
|
20 | 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.
|
21 |
|
22 | In addition, it is helpful if you upload your Clinic.js data to help us diagnose your issues.
|
23 | Use the `clinic upload` tool to do this:
|
24 |
|
25 | ```
|
26 | clinic upload 10000.clinic-doctor
|
27 | ```
|
28 |
|
29 | After the upload has finished, add the printed upload id to your issue.
|
30 |
|
31 | ## For Developers
|
32 |
|
33 | All contributions should fit the [standard](https://github.com/standard/standard) linter, and pass the tests.
|
34 | You can test this by running:
|
35 |
|
36 | ```
|
37 | npm test
|
38 | ```
|
39 |
|
40 | In addition, make sure to add tests for any new features.
|
41 | You can test the test coverage by running:
|
42 |
|
43 | ```
|
44 | npm run ci-cov
|
45 | ```
|
46 |
|
47 | ## For Collaborators
|
48 |
|
49 | 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.
|
50 |
|
51 | Release process:
|
52 |
|
53 | - `npm test`
|
54 | - `npm version <major|minor|patch>`
|
55 | - `git push && git push --tags`
|
56 | - `npm publish`
|
57 |
|
58 | -----------------------------------------
|
59 |
|
60 | ## Licensing and Certification
|
61 |
|
62 | While the Clinic.js project as a whole is distributed under the GPL 3.0
|
63 | license, all contributions to the Clinic.js project are submitted *to* the
|
64 | project under the MIT license. This gives the project maintainers flexibility
|
65 | while ensuring that your rights to your contributions do not change.
|
66 |
|
67 | The Clinic.js project uses a Contribution Certification that is derived from
|
68 | the [Developer Certificate of Origin][DCO]. It is important to note that the
|
69 | Contribution Certification *is not the same as the standard DCO* and we do not
|
70 | use the term "DCO" or "Developer Certificate of Origin" to describe it to avoid
|
71 | confusion. Nevertheless, the intent and purpose is effectively the same.
|
72 |
|
73 | Every contributor agrees to the Contribution Certification by including a
|
74 | `Signed-off-by` statement within each commit. The statement *must* include
|
75 | the contributor's real full name and email address.
|
76 |
|
77 | ```
|
78 | Signed-off-by: J. Random User <j.random.user@example.com>
|
79 | ```
|
80 |
|
81 | ### Certification
|
82 |
|
83 | By making a contribution to this project, I certify that:
|
84 |
|
85 | (a) The contribution was created in whole or in part by me and I have the right
|
86 | to and hereby submit it under the MIT license; or
|
87 |
|
88 | (b) The contribution is based upon previous work that, to the best of my
|
89 | knowledge, is covered under an appropriate open source license and I have the
|
90 | right under that license to submit that work with modifications, whether created
|
91 | in whole or in part by me, under the MIT License; or
|
92 |
|
93 | (c) The contribution was provided directly to me by some other person who
|
94 | certified (a), (b) or (c) and I have not modified it.
|
95 |
|
96 | (d) I understand and agree that this project and the contribution are public
|
97 | and that a record of the contribution (including all personal information I
|
98 | submit with it, including my sign-off) is maintained indefinitely and may be
|
99 | redistributed consistent with this project or license(s) involved.
|
100 |
|
101 | [CoC]: CODE_OF_CONDUCT.md
|
102 | [DCO]: https://developercertificate.org/
|