Skip to content

Contributing.md

Latest commit

 

History

History
117 lines (94 loc) · 4.96 KB

Contributing.md

File metadata and controls

117 lines (94 loc) · 4.96 KB
Raw

Contributing to the SPDX 3 model

General

SPDX is always welcoming new contributors!

The discussions are happening on the spdx-tech mailing list and during our regular meetings.

All the details are in: https://spdx.dev/participate/tech/

This repository consists of files written in a specific Markdown format describing the model classes, datatypes, properties, and vocabularies which will be used to automatically create documentation, ontologies, and validation artifacts. These are organized by profile.

Use spec-parser to validate your Markdown for errors. For instructions on integrating it with MkDocs to generate and test your specification HTML, refer to the build guide.

Please submit a pull request or an issue for any suggested changes or issues you find.

Significant changes between versions should be logged to CHANGELOG.md.

Contribution License Agreement

Contributions to this repository are made pursuant to the SPDX Community Specification Contributor License Agreement 1.0. You do not need to submit a signed copy of the contributor license agreement; by making a contribution to this repo, you agree to the terms set forth in that agreement.

Contributing to a specific profile

There are multiple profiles being developed in parallel for the SPDX 3 model.

  • During its initial phase of development, a profile working group will contribute changes to its own branch in this repository.
    • For example, any changes to the "Future" profile should be submitted as a change request to the future-profile branch.
  • There will be at least one maintainer per profile in charge of merging any profile development changes to the profile-specific branch.
  • Once the first "complete" version of a profile is ready, the profile maintainer will alert the general SPDX tech group that the profile model is ready for review.
  • Once alerted, the SPDX tech group will review and provide feedback.
  • Once profile proposals have been reviewed and approved, the profile-specific branch will be merged to a general develop branch along with the other reviewed profile models.
  • Once the profile in develop branch is stable, its code from the develop branch will be merged to main.

At this point the SPDX tech team will re-evaluate the best way to continue updating individual profiles.

This method of development was agreed upon by the SPDX Tech team on 2023-01-17.

Translation

Translations of model descriptions are welcome. Please see translation.md for details.

Profile maintainers

In accordance with the development model described above, each profile has at least one maintainer in charge of merging profile-specific changes to the profile working branch.

To contribute to a specific profile, please open a PR to the profile-specific branch or reach out to the maintainer of the profile (noted below).

Each profile in active development phase also has their own regular meeting time.

Profile Maintainer(s)
AI Gopi Krishnan Rajbahadur and Arthit Suriyawongkul
Build Brandon Lum and Nisha Kumar
Core William Bartholomew, Gary O'Neall, and Kate Stewart
Dataset Gopi Krishnan Rajbahadur and Arthit Suriyawongkul
FunctionalSafety Nicole Pappler
Hardware Steven Carbno and Alfred Strauch
Licensing Steve Winslow and Alexios Zavras
Operations Ummo Schwarting
Security Thomas Steenbergen, Adolfo García Veytia, and Rose Judge
Service Gary O'Neall
Software Alexios Zavras and Gary O'Neall
SupplyChain Steven Carbno and Alfred Strauch