-
Notifications
You must be signed in to change notification settings - Fork 8.3k
doc: add contributing non-Apache2.0 docs #1561
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: add contributing non-Apache2.0 docs #1561
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR= Pull Request
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR is defined in the previous paragraph.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no need to send email if it is part of the pull request, so I would remove this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I got that from the PPT presentation. I'll remove it here.
|
I think I'd like to see a "first step" added that encourages contributors to contact the TSC (or developer mailing list) to ask about adding a component capability before they go through the work of submitting a PR with a change. Your thoughts? |
+1 |
CONTRIBUTING.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
insure
I'd think this should be "ensure".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can not
Normal spelling is "cannot", no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one is tricky too. Both spellings are acceptable. I was thinking can not felt more emphatic when written that way. I'll flip a coin.... heads says "cannot" :)
Add contribution process for including non-Apache 2.0 components as approved by the TSC. Include a README template that lists information requested by the TSC and governing board for review. Add a brief mention in the CONTRIBUTING link that appears when submitting a new PR or Issue via the GitHub web interface. Included an introduction to the process steps that includes using the zephyr devel mailing list to discuss new components. fixes #1543 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
mbolivar
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of nits, not meaning to stand in the way of the merge and feel free to ignore.
| Zephyr uses the `Apache 2.0 license`_ (as found in the LICENSE file in | ||
| the project's `GitHub repo`_) to strike a balance between open | ||
| contribution and allowing you to use the software however you would like | ||
| to. The Apache 2.0 license is a permisive open source license that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"permissive" typo
| #. Complete a README for your code component and add it to your source | ||
| code pull request (PR). A recommended README template can be found in | ||
| :file:`doc/contributing/code_component_README` (and included | ||
| `below`_ for reference) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Internal reference; shouldn't this be:
:ref:`below`
Currently ashell boot doesn't work with javascript with callbacks or timers. This is because once the boot.cfg JS gets called, it goes into an infinite loop waiting for uart. Until it gets the connection, it won't return. This means the main loop doesn't get control back, meaning callbacks are not processed. This breaks the code up a bit so that it checks if the connection is ready when uart_process gets called, if not try to connect. If the connection fails, just return and go through the main loop again. Continue until a connection is made. Fixes zephyrproject-rtos#1561 Signed-off-by: Brian J Jones <brian.j.jones@intel.com>
Add contribution process for including non-Apache 2.0 components
as approved by the TSC. Include a README template that lists
information requested by the TSC and governing board for review.
Add a brief mention in the CONTRIBUTING link that appears when
submitting a new PR or Issue via the GitHub web interface.
fixes #1543
Signed-off-by: David B. Kinder david.b.kinder@intel.com