THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx
Difference between revisions of "Technical Team/RDF Vocabulary Contributions - HOWTO"
From SPDX Wiki
| Line 1: | Line 1: | ||
| − | To make contributions to the spec please follow these steps. | + | <p>To make contributions to the spec please follow these steps. |
| − | <ol> | + | </p><ol> |
| − | <li><a href="http://bugs.linux-foundation.org/enter_bug.cgi?product=spdx">Report the issue</a>. Reporting | + | <li><a href="http://bugs.linux-foundation.org/enter_bug.cgi?product=spdx">Report the issue</a>. Reporting an issue is a huge contribute. You can stop here and have our gratitude. If you want to try to fix the issue you can follow the steps below.</li> |
<li>Clone the repository and setup the build system (see below).</li> | <li>Clone the repository and setup the build system (see below).</li> | ||
<li>Create a feature branch.</li> | <li>Create a feature branch.</li> | ||
| Line 17: | Line 17: | ||
<ol> | <ol> | ||
<li>Install Ruby 1.9.2 using the appropriate mechanism for your OS. (Earlier versions of Ruby will probably work but have not been tested.)</li> | <li>Install Ruby 1.9.2 using the appropriate mechanism for your OS. (Earlier versions of Ruby will probably work but have not been tested.)</li> | ||
| − | <li>Install sqlite3-ruby gem: | + | <li>Install sqlite3-ruby gem: gem install --source http://rubygems.org sqlite3-ruby --version 1.2.5</li> |
<li>Install rdf-context gem: <code>gem install --source http://rubygems.org rdf_context</code></li> | <li>Install rdf-context gem: <code>gem install --source http://rubygems.org rdf_context</code></li> | ||
<li>Install mustache gem: <code>gem install --source http://rubygems.org mustache</code></li> | <li>Install mustache gem: <code>gem install --source http://rubygems.org mustache</code></li> | ||
| Line 24: | Line 24: | ||
<p>One you have performed those installations you can generate the full specification by running <code>rake</code> in the spec-spec directory. This will product a full html version of the spec, <code>build/spdx-1.0.html</code>, and an rdf owl file containing the spdx ontology, <code>build/spdx-1.0-ont.html</code>. | <p>One you have performed those installations you can generate the full specification by running <code>rake</code> in the spec-spec directory. This will product a full html version of the spec, <code>build/spdx-1.0.html</code>, and an rdf owl file containing the spdx ontology, <code>build/spdx-1.0-ont.html</code>. | ||
| − | If you have any issues getting up and running let us know and we'll get your issue sorted out. | + | If you have any issues getting up and running let us know and we'll get your issue sorted out.</p> |
Revision as of 00:47, 5 January 2011
To make contributions to the spec please follow these steps.
- <a href="http://bugs.linux-foundation.org/enter_bug.cgi?product=spdx">Report the issue</a>. Reporting an issue is a huge contribute. You can stop here and have our gratitude. If you want to try to fix the issue you can follow the steps below.
- Clone the repository and setup the build system (see below).
- Create a feature branch.
- Make your changes on that branch.
- <a href="http://spdx.org/wiki/proposals">Create a proposal</a> linking to the issue and describing your changes. Be sure to attach a patch (and include a link to your branch is if it published anywhere).
Specification development setup
The master source for the specification resides in a git repository hosted at linuxfoundation.org. Anyone can clone a working copy by doing git clone http://git.linuxfoundation.org/spdx-spec.git.
The spdx specification build system is based on ruby. The following steps are required to work on the specification:
- Install Ruby 1.9.2 using the appropriate mechanism for your OS. (Earlier versions of Ruby will probably work but have not been tested.)
- Install sqlite3-ruby gem: gem install --source http://rubygems.org sqlite3-ruby --version 1.2.5
- Install rdf-context gem:
gem install --source http://rubygems.org rdf_context - Install mustache gem:
gem install --source http://rubygems.org mustache
One you have performed those installations you can generate the full specification by running rake in the spec-spec directory. This will product a full html version of the spec, build/spdx-1.0.html, and an rdf owl file containing the spdx ontology, build/spdx-1.0-ont.html.
If you have any issues getting up and running let us know and we'll get your issue sorted out.
