Skip to content

Commit f6430ec

Browse files
committed
feat: prepare "contrib" area
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent aff9636 commit f6430ec

File tree

3 files changed

+47
-0
lines changed

3 files changed

+47
-0
lines changed

cyclonedx/contrib/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# CycloneDX Contrib Extensions
2+
3+
This directory contains community-contributed functionality that extends the capabilities of the CycloneDX core library.
4+
Unlike the modules in `../`, these features are not part of the official CycloneDX specification and may vary in stability, scope, or compatibility.
5+
6+
## Contents
7+
- Utilities, helpers, and experimental features developed by the community
8+
- Optional add-ons that may facilitate or enhance use of the CycloneDX core library
9+
- Code that evolves independently of the CycloneDX specification
10+
11+
## Notes
12+
- Contrib modules are optional and not required for strict compliance with the CycloneDX standard.
13+
- They may change more frequently than the core and are not guaranteed to follow the same versioning rules.
14+
- Users should evaluate these modules carefully and consult documentation or source comments for details.
15+
16+
## Contributing
17+
Contributions are welcome. To add an extension:
18+
1. Follow the contribution guidelines in the main repository.
19+
2. Place your code in a clearly named subfolder or file under `contrib/`.
20+
3. Provide documentation and tests to ensure clarity and maintainability.

cyclonedx/contrib/__init__.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# This file is part of CycloneDX Python Library
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
#
15+
# SPDX-License-Identifier: Apache-2.0
16+
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
18+
19+
"""
20+
Some features in this library are marked as contrib. These are community-provided extensions and are not part of the
21+
official standard. They are optional and may evolve independently from the core.
22+
"""
23+
24+
__all__ = [
25+
# there is no intention to export anything in here.
26+
#
27+
]

tests/test_contrib/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)