|
1 | | -# Contributing to Node.js |
| 1 | +# Contributing to node |
2 | 2 |
|
3 | | -Contributions to Node.js include code, documentation, answering user questions, |
4 | | -running the project's infrastructure, and advocating for all types of Node.js |
5 | | -users. |
| 3 | +Thank you for your interest in contributing! Here's how you can help. |
6 | 4 |
|
7 | | -The Node.js project welcomes all contributions from anyone willing to work in |
8 | | -good faith with other contributors and the community. No contribution is too |
9 | | -small and all contributions are valued. |
| 5 | +## Getting Started |
10 | 6 |
|
11 | | -The Node.js project has an open governance model. |
12 | | -Individuals making significant and valuable contributions are made |
13 | | -Collaborators and given commit-access to the project. See the |
14 | | -[GOVERNANCE.md](./GOVERNANCE.md) document for more information about how this |
15 | | -works. |
| 7 | +1. Fork the repository |
| 8 | +2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/node.git` |
| 9 | +3. Create a branch: `git checkout -b feature/your-feature` |
| 10 | +4. Make your changes |
| 11 | +5. Commit with a descriptive message |
| 12 | +6. Push to your fork and submit a pull request |
16 | 13 |
|
17 | | -## Contents |
| 14 | +## Reporting Issues |
18 | 15 |
|
19 | | -* [Code of Conduct](#code-of-conduct) |
20 | | -* [Issues](#issues) |
21 | | -* [Pull Requests](#pull-requests) |
22 | | -* [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin-11) |
| 16 | +- Use the GitHub issue tracker |
| 17 | +- Include steps to reproduce the problem |
| 18 | +- Include your environment details (OS, language version, etc.) |
23 | 19 |
|
24 | | -## [Code of Conduct](./doc/contributing/code-of-conduct.md) |
| 20 | +## Code Style |
25 | 21 |
|
26 | | -The Node.js project has a |
27 | | -[Code of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md) |
28 | | -to which all contributors must adhere. |
| 22 | +- Follow the existing code style in the project |
| 23 | +- Add tests for new functionality |
| 24 | +- Update documentation as needed |
29 | 25 |
|
30 | | -See [details on our policy on Code of Conduct](./doc/contributing/code-of-conduct.md). |
| 26 | +## Pull Requests |
31 | 27 |
|
32 | | -## [Issues](./doc/contributing/issues.md) |
| 28 | +- Keep PRs focused on a single change |
| 29 | +- Write a clear description of what and why |
| 30 | +- Reference any related issues |
33 | 31 |
|
34 | | -* [Asking for General Help](./doc/contributing/issues.md#asking-for-general-help) |
35 | | -* [Discussing non-technical topics](./doc/contributing/issues.md#discussing-non-technical-topics) |
36 | | -* [Submitting a Bug Report](./doc/contributing/issues.md#submitting-a-bug-report) |
37 | | -* [Triaging a Bug Report](./doc/contributing/issues.md#triaging-a-bug-report) |
| 32 | +## License |
38 | 33 |
|
39 | | -## [Pull Requests](./doc/contributing/pull-requests.md) |
40 | | - |
41 | | -Pull Requests are the way concrete changes are made to the code, documentation, |
42 | | -dependencies, and tools contained in the `nodejs/node` repository. |
43 | | - |
44 | | -* [Dependencies](./doc/contributing/pull-requests.md#dependencies) |
45 | | -* [Setting up your local environment](./doc/contributing/pull-requests.md#setting-up-your-local-environment) |
46 | | -* [The Process of Making Changes](./doc/contributing/pull-requests.md#the-process-of-making-changes) |
47 | | -* [Reviewing Pull Requests](./doc/contributing/pull-requests.md#reviewing-pull-requests) |
48 | | -* [Notes](./doc/contributing/pull-requests.md#notes) |
49 | | - |
50 | | -## Developer's Certificate of Origin 1.1 |
51 | | - |
52 | | -```text |
53 | | -By making a contribution to this project, I certify that: |
54 | | -
|
55 | | - (a) The contribution was created in whole or in part by me and I |
56 | | - have the right to submit it under the open source license |
57 | | - indicated in the file; or |
58 | | -
|
59 | | - (b) The contribution is based upon previous work that, to the best |
60 | | - of my knowledge, is covered under an appropriate open source |
61 | | - license and I have the right under that license to submit that |
62 | | - work with modifications, whether created in whole or in part |
63 | | - by me, under the same open source license (unless I am |
64 | | - permitted to submit under a different license), as indicated |
65 | | - in the file; or |
66 | | -
|
67 | | - (c) The contribution was provided directly to me by some other |
68 | | - person who certified (a), (b) or (c) and I have not modified |
69 | | - it. |
70 | | -
|
71 | | - (d) I understand and agree that this project and the contribution |
72 | | - are public and that a record of the contribution (including all |
73 | | - personal information I submit with it, including my sign-off) is |
74 | | - maintained indefinitely and may be redistributed consistent with |
75 | | - this project or the open source license(s) involved. |
76 | | -``` |
| 34 | +By contributing, you agree that your contributions will be licensed under the same license as the project. |
0 commit comments