Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (68 loc) · 4.62 KB

CONTRIBUTING.md

File metadata and controls

89 lines (68 loc) · 4.62 KB

Contributing to the OCCT Samples & Projects Registry

Thank you for proposing your project for the OCCT community registry. The registry is for OCCT-team projects and open-source third-party projects built on OCCT. No CLA required - the corpus is yaml metadata + Markdown, and contributions are accepted without signature.

How to contribute

You can contribute either via an Issue (zero git knowledge needed) or directly via a Pull Request.

1. Project Registration issue - easiest

  1. Go to Issues -> New issue -> Project Registration.
  2. Fill out every required field. Maintainers cannot guess license, homepage, or contact details.
  3. A maintainer will land your entry as a PR and ping you for review.

2. Direct pull request

  1. Pick the right bucket: applications/, libraries/, wrappers/, or examples/. Use examples/ for sample/demo apps that live in their own repositories (OCCT-team or community-maintained).
  2. Pick (or create) a category subfolder. If creating a new category, also add a one-paragraph README.md explaining what belongs there.
  3. Create your project folder using a kebab-case slug: <bucket>/<category>/<slug>/
  4. Copy an existing project.yaml (e.g. examples/csharp/occt-samples-csharp/project.yaml) and fill it in. The schema is documented in SCHEMA.md.
  5. Add a README.md with a longer description, screenshots, and links.
  6. Optionally, add a snippets/ subfolder with runnable usage examples that show how the project consumes OCCT. Keep snippets minimal and self-contained.
  7. Open a PR. Title prefix: Add <Project Name>.

Acceptance checklist

  • Project is open-source or has clear public adoption + maintenance.
  • project.yaml validates against the schema in SCHEMA.md.
  • All industries, scopes, software-type, and license values come from _taxonomy.yaml. If a value is missing, add it to the taxonomy in the same PR.
  • README.md describes the project in 2-4 paragraphs and links to its homepage and repository.
  • You are the project maintainer, or you have permission to register the project on their behalf.

Updating an existing entry

Open a PR editing the relevant project.yaml / README.md. Maintainers prefer a single-purpose PR per project. Use the title prefix Samples - Update <Project Name>.

Removing an entry

If a project is abandoned or its maintainers request removal, set status: archived in project.yaml rather than deleting the folder. Hard removal is reserved for entries that violated the acceptance criteria.

Maintainer takedown / correction requests

If you are the maintainer of a listed project and want the entry removed or corrected:

  1. Open a GitHub issue with the title Samples - Remove <project name> or Samples - Correct <project name> - a short note explaining the request is enough, OR
  2. Reach the OCCT maintainers via the contact form at dev.opencascade.org/webform/contact_us (or the "Contact us" link on occt3d.com).

Removal takes effect on the current branch and in subsequent releases. Git history is retained as a normal part of version control; the repository does not rewrite history for routine removal requests.

Provenance: the source: field

Every project.yaml declares how the entry came to exist:

source value When to use
occt-team Authored or maintained by Open Cascade SAS / OCCT project.
maintainer-confirmed Project maintainer (or someone with their permission) registered the entry - either through the Project Registration flow on this repository, or had previously opted in via the dev.opencascade.org listing form.

Every entry must carry one of these two values. We do not add entries proactively from third-party public sources - the maintainer opts in (or the entry is OCCT-team authored).