THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx

Difference between revisions of "Technical Team/Best Practices"

From SPDX Wiki
Jump to: navigation, search
Line 6: Line 6:
  
 
= Introduction =
 
= Introduction =
 +
 +
= Interpreting the Specification =
  
 
Clarify and help with what is in the spec. Structure sections around the spec?
 
Clarify and help with what is in the spec. Structure sections around the spec?
 
  
 
= Tools =
 
= Tools =
  
 
Best practices around using the SPDX tools
 
Best practices around using the SPDX tools
 +
 +
= Contributing to SPDX =
 +
 +
how to provide feedback, get involved, etc
 +
 +
= Producing =
 +
 +
Best practices around the process of doing it. Examples of how this  is done.
 +
 +
= Consuming =
 +
 +
Best practices around the process of doing it. Examples of how this  is done.
  
 
= Notes from LinuxCon 2013 17 Sept 2013 =
 
= Notes from LinuxCon 2013 17 Sept 2013 =
Line 25: Line 38:
 
* best practices around the specification and best practices around contributing to SPDX. Maybe two documents?
 
* best practices around the specification and best practices around contributing to SPDX. Maybe two documents?
 
* Snapshot best practices document at intervals and post on site. Use wiki for active discussions, new proposals, etc.,.
 
* Snapshot best practices document at intervals and post on site. Use wiki for active discussions, new proposals, etc.,.
*
+
* Should we have a getting started guide?

Revision as of 14:57, 17 September 2013

This is a place holder for working on the Best Practices document.

Best Practices

Introduction

Interpreting the Specification

Clarify and help with what is in the spec. Structure sections around the spec?

Tools

Best practices around using the SPDX tools

Contributing to SPDX

how to provide feedback, get involved, etc

Producing

Best practices around the process of doing it. Examples of how this is done.

Consuming

Best practices around the process of doing it. Examples of how this is done.

Notes from LinuxCon 2013 17 Sept 2013

What should be in a best practices, how does it relate to the spec?

Possibilities:

  • examples
  • particular questions (sort of like a FAQ)
  • Could start with things that are not well defined but end up in the specification
  • I need a field for X, its not there, what field could I use?
  • best practices around the specification and best practices around contributing to SPDX. Maybe two documents?
  • Snapshot best practices document at intervals and post on site. Use wiki for active discussions, new proposals, etc.,.
  • Should we have a getting started guide?