Updates to README.md, and initial CONTRIBUTING.md, GOVERNANCE.md, INSTALL.md #397
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lgritz
reviewed
Jun 12, 2019
CONTRIBUTING.md
Outdated
| Every commit must be signed off. That is, every commit log message | ||
| must include a “`Signed-off-by`” line (generated, for example, with | ||
| “`git commit --signoff`”), indicating that the committer wrote the | ||
| code and has the right to release it under the [MPL |
lgritz
reviewed
Jun 12, 2019
| They look like this: | ||
|
|
||
| /// Explanation of a class. Note THREE slashes! | ||
| /// Also, you need at least two lines like this. If you don't have enough |
There was a problem hiding this comment.
This is no longer true -- I don't know if I misunderstood originally, or if Doxygen has gotten smarter over the years. But the blank commented line is not necessary and Doxygen is perfectly happy with a one-line triple-slash comment.
|
Yep - copy/paste error, I think that came from OpenVDB.
…On Wed, Jun 12, 2019 at 11:30 AM Larry Gritz ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In CONTRIBUTING.md
<#397 (comment)>:
> +Licence Agreement](http://www.openexr.com/downloads/OpenEXRCorporateContributorLicenseAgreement.docx).
+
+Download the appropriate CLA from the links above (or find them in the
+src/doc directory of the software distribution), print, sign, and
+rescan it (or just add a digital signature directly), and email it
+back to us at ***@***.******@***.***).
+
+The OpenEXR CLA's are the standard forms used by Linux Foundation
+projects.
+
+### Commit Sign-Off
+
+Every commit must be signed off. That is, every commit log message
+must include a “`Signed-off-by`” line (generated, for example, with
+“`git commit --signoff`”), indicating that the committer wrote the
+code and has the right to release it under the [MPL
OpenEXR is not MPL, right?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#397>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AFC3DGO45ND2ATFJ6XKGNADP2E6EBANCNFSM4HXNNXYQ>
.
--
Cary Phillips | R&D Supervisor | ILM | San Francisco
|
|
I lifted the code style section from OCIO and haven't modified it yet.
…On Wed, Jun 12, 2019 at 11:33 AM Larry Gritz ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In CONTRIBUTING.md
<#397 (comment)>:
> +Feel free to use Boost classes you already see in the code base, but don't
+use any Boost you don't see us already using, without first checking with
+the project leader.
+
+#### Comments and Doxygen
+
+Comment philosophy: try to be clear, try to help teach the reader what's
+going on in your code.
+
+Prefer C++ comments (starting line with `//`) rather than C comments (`/* ... */`).
+
+For public APIs we tend to use Doxygen-style comments (start with `///`).
+They look like this:
+
+ /// Explanation of a class. Note THREE slashes!
+ /// Also, you need at least two lines like this. If you don't have enough
This is no longer true -- I don't know if I misunderstood originally, or
if Doxygen has gotten smarter over the years. But the blank commented line
is not necessary and Doxygen is perfectly happy with a one-line
triple-slash comment.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#397>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AFC3DGPX5UG53W4SL76NMSLP2E6PBANCNFSM4HXNNXYQ>
.
--
Cary Phillips | R&D Supervisor | ILM | San Francisco
|
lgritz
reviewed
Jun 12, 2019
|
|
||
| ### How to Ask for Help | ||
|
|
||
| If you have trouble installing, building, or using the library, but there's not yet reason to suspect you've encountered a genuine bug, start by posting a question to the [openexr-dev](http://lists.aswf.io/openexr-dev) mailing list. This is the place for question such has "How do I...". |
There was a problem hiding this comment.
I love this paragraph and am going to steal it for my projects.
|
I thought I stole that from you.... ;)
…On Wed, Jun 12, 2019 at 12:46 PM Larry Gritz ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In CONTRIBUTING.md
<#397 (comment)>:
> +explains our contribution process and procedures
+
+## Getting Information
+
+There are two primary ways to connect with the OpenEXR project:
+
+* The [openexr-dev](https://lists.aswf.io/g/openexr-dev) mail list:
+This is a development focused mail list with a deep history of
+technical conversations and decisions that have shaped the project.
+
+* [GitHub Issues](https://github.com/openexr/openexr/issues): GitHub
+**issues** are used both to track bugs and to discuss feature requests.
+
+### How to Ask for Help
+
+If you have trouble installing, building, or using the library, but there's not yet reason to suspect you've encountered a genuine bug, start by posting a question to the [openexr-dev](http://lists.aswf.io/openexr-dev) mailing list. This is the place for question such has "How do I...".
I love this paragraph and am going to steal it for my projects.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#397>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AFC3DGOXQNG733F6ZWMUTBTP2FHB7ANCNFSM4HXNNXYQ>
.
--
Cary Phillips | R&D Supervisor | ILM | San Francisco
|
- fixed references to license - removed references to CI - added section on GitHub labels Signed-off-by: Cary Phillips <cary@ilm.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All work in progress, cobbled together from OpenColorIO, OpenVDB, OpenCue and other well-documented projects.