Add contribution guidelines. #1348
Conversation
|
|
||
| It happens all the time, for many reasons, and not necessarily because the code is bad. Take the feedback, adapt your code, and try again. Remember, the ultimate goal is to preserve the quality of the code and maintain the focus of the Project through intensive review. | ||
|
|
||
| Maintainers and Committers typically have to process a lot of submissions, and the time for any individual response is generally limited. If the reason for rejection is unclear, please ask for more information to the Maintainers and Committers. |
There was a problem hiding this comment.
(syntax) ?from? the Maintainers and Committers
| * Listen and be open to all different opinions. | ||
| * Help each other. | ||
|
|
||
| Changes are submitted via pull requests and only the Maintainers and Committers should approve or reject the pull request. |
There was a problem hiding this comment.
The difference between Maintainers and Committers is unclear for me at this point.
There was a problem hiding this comment.
The key difference is that only a Maintainer can do the final approval of patches (see https://github.com/Samsung/jerryscript/wiki/Governance#maintainer). However, Committers are still strongly encouraged to review and approve patches (even if ultimately the approval is not binding and the Maintainer has the last word).
There was a problem hiding this comment.
IMHO, this should be mentioned in this MD file too.
|
Addressed the review feedback. Now starting to merge #1347 into this PR. |
|
|
||
| > (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project, under the same open source license. | ||
|
|
||
| We have the same requirements for using the signed-off-by process as the Linux kernel. |
There was a problem hiding this comment.
I'd drop this line and the following rest from here. It is duplicated in CONTRIBUTING.md and it's a better fit there anyway
There was a problem hiding this comment.
I don't think we can drop this, DCO.md specifies the terms and conditions of the DCO and the format of the "Signed-off-by" line is part of that. That's what I was referring to when I mentioned that I tried to make DCO.md as small as possible :)
Ideally we would just include DCO.md into CONTRIBUTING.md but unfortunately GitHub does not support this and there are no plans to add that in the future (too many security implications).
I'm afraid we just have to live with the small amount of duplication here.
| @@ -38,8 +38,11 @@ For additional information see [Getting Started](docs/01.GETTING-STARTED.md). | |||
| - [API Example](docs/03.API-EXAMPLE.md) | |||
| - [Internals](docs/04.INTERNALS.md) | |||
|
|
|||
| ## Contributing | |||
| The project can only accept contributions which are licensed under the [Apache License 2.0](LICENSE) and are signed according to the JerryScript [Developer's Certificate of Origin](DCO.md). For further information please see [CONTRIBUTING.md](CONTRIBUTING.md). | |||
There was a problem hiding this comment.
just a stylistic suggestion: please see [Contribution Guidelines](CONTRIBUTING.md). ?
| @@ -0,0 +1,75 @@ | |||
| ## Patch Submission Process | |||
There was a problem hiding this comment.
Don't we need a top-level heading # Contribution Guidelines here?
The current content in CONTRIBUTING.md is largely based on the "Patch Submission Process" Wiki page. This commit also moves the DCO from the Wiki into the source tree. In addition, clarify in README.md that contributions need to be licensed under the Apache License 2.0 and signed with the DCO. JerryScript-DCO-1.0-Signed-off-by: Tilmann Scheller t.scheller@samsung.com
|
LGTM |
The current content in CONTRIBUTING.md is largely based on the "Patch Submission Process" Wiki page. This commit also moves the DCO from the Wiki into the source tree. In addition, clarify in README.md that contributions need to be licensed under the Apache License 2.0 and signed with the DCO. JerryScript-DCO-1.0-Signed-off-by: Tilmann Scheller t.scheller@samsung.com
Add contribution guidelines and DCO.
The current content in CONTRIBUTING.md is largely based on the "Patch Submission Process" Wiki page.
This commit also moves the DCO from the Wiki into the source tree.
In addition, clarify in README.md that contributions need to be licensed under the Apache License 2.0 and signed with the DCO.
JerryScript-DCO-1.0-Signed-off-by: Tilmann Scheller t.scheller@samsung.com