Bug 34017 – website: Mention on contributing code page where to find preferred license text

• Status: RESOLVED
• Resolution: FIXED
• Component: WebKit Website

[Chris Jerdonek]

This came up here:

https://bugs.webkit.org/show_bug.cgi?id=33475#c9

[Chris Jerdonek]

Created attachment 47257 [details]
Proposed patch

[David Kilzer (:ddkilzer)]

Comment on attachment 47257 [details]
Proposed patch

> diff --git a/WebKitSite/coding/contributing.html b/WebKitSite/coding/contributing.html
> -    <li>Add any new files and layout tests to Subversion using the <tt>svn add</tt> command.</li>
> +    <li>Add any <a href="#newfiles">new files</a> to your local checkout.</li>

I would say "working directory" instead of "checkout" here.

> +<h3 id="writecode">Develop your changes</h3>
> +
> +<p>If you make substantive changes to a file, you may wish to add a
> +copyright line for yourself or for the company on whose behalf you
> +work. Below is an example copyright line for an individual contributor:
> +
> +<p><tt>Copyright (C) 2010 John Smith ([e-mail])</tt></p>

I would add an example for a company copyright as well (and modify the text above):

work. Below is an example copyright line for an individual contributor and a company:

<p><tt>Copyright (C) 2010 John Smith ([e-mail])</tt></p>
<p><tt>Copyright (C) 2010 Company Inc. All rights reserved.</tt></p>

> +<p>In addition, make sure that any new code files you introduce contain

I suggest changing "new code files" to "new source code files".  Maybe include "scripts" as well:

<p>In addition, make sure that all new scripts and source code files that you introduce contain

> +license text at the beginning of the file. If you are the author of
> +a new file, preferred license text to include can be found here:
> +<a href="http://trac.webkit.org/browser/trunk/WebKit/LICENSE">WebKit/LICENSE</a>.
> +(The "Original Format" link at the bottom of the page contains text
> +that can be cut and pasted more easily.) Simply replace the copyright
> +line with your own information, for example as suggested above.

> +<h3 id="newfiles">Add new files to your checkout</h3>

Change "checkout" to "working directory".

> +<p>If your changes include adding new files (like new layout tests),
> +use the <tt>svn add</tt> command to mark these files for addition to the
> +repository. If you do not do this, the new files will be missing from
> +the patch file you generate below.</p>
> +
> +<p>You can learn more about Subversion commands like <tt>svn add</tt>
> +from the online book <a href="http://svnbook.red-bean.com/">Version
> +Control with Subversion</a> and from the <tt>svn help</tt> command.</p>

Book titles should be quoted:

from the online book "<a href="http://svnbook.red-bean.com/">Version
Control with Subversion</a>" and from the <tt>svn help</tt> command.</p>

r=me, but consider the minor editing suggestions above (cq-).

[Chris Jerdonek]

(In reply to comment #2)

Thanks for the review, David!  Great comments.

> > +<p>You can learn more about Subversion commands like <tt>svn add</tt>
> > +from the online book <a href="http://svnbook.red-bean.com/">Version
> > +Control with Subversion</a> and from the <tt>svn help</tt> command.</p>
> 
> Book titles should be quoted:
> 
> from the online book "<a href="http://svnbook.red-bean.com/">Version
> Control with Subversion</a>" and from the <tt>svn help</tt> command.</p>

One minor point.  I believe book titles should be underlined or italicized rather than quoted.  (It is chapter titles in books and article titles within magazines, for example, that are quoted.)  You can see an example of this behavior on their web site: http://svnbook.red-bean.com .

[David Kilzer (:ddkilzer)]

(In reply to comment #3)
> (In reply to comment #2)
> 
> Thanks for the review, David!  Great comments.
> 
> > > +<p>You can learn more about Subversion commands like <tt>svn add</tt>
> > > +from the online book <a href="http://svnbook.red-bean.com/">Version
> > > +Control with Subversion</a> and from the <tt>svn help</tt> command.</p>
> > 
> > Book titles should be quoted:
> > 
> > from the online book "<a href="http://svnbook.red-bean.com/">Version
> > Control with Subversion</a>" and from the <tt>svn help</tt> command.</p>
> 
> One minor point.  I believe book titles should be underlined or italicized
> rather than quoted.  (It is chapter titles in books and article titles within
> magazines, for example, that are quoted.)  You can see an example of this
> behavior on their web site: http://svnbook.red-bean.com .

Hmm...I guess it's been a while since my English classes in high school.  Please decorate the text as appropriate.  I think italics is preferred to underline.  :)

[Chris Jerdonek]

Manually committed r53782 (via "git svn dcommit"):

http://trac.webkit.org/changeset/53782

I added a "book" CSS class. :)