lili/OCCT

mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-08-08 23:07:28 +08:00

Files

T

Pasukhin Dmitry fcf1ea22e9 Documentation, Configuration - Correct guides and generation setup (#1404 )

Correct obsolete API references, code examples, terminology, links, and
contribution workflow instructions across the documentation.

Generate Doxygen example paths from OCCT package metadata and fix license
markup. Remove obsolete documentation CMake, layout, and unused PDF
generation files.

2026-07-29 00:36:13 +01:00

3.6 KiB

Raw Blame History

Contributing to OCCT

Contribute Code

In order to contribute code to OCCT you must sign the Contributor License Agreement (CLA).

Steps to Submit Your Contribution

Fork the repository on GitHub: https://github.com/Open-Cascade-SAS/OCCT
Create a feature branch from an up-to-date IR. Any descriptive branch name is fine.
Develop your change following the OCCT Coding Rules. Format the source with clang-format using the .clang-format configuration shipped in the repository.
Test locally. Run the existing DRAW test suite and OpenCascadeGTest tests; create a test case for the change when applicable.
Open a Draft Pull Request against Open-Cascade-SAS/OCCT:IR. CI/CD pipelines run on every push and report build, style and test results.
Mark the PR Ready for Review once CI is green. A maintainer will review the change and request updates as needed.
Address review feedback by pushing additional commits to the same branch; CI re-runs automatically.
After approval the PR is merged (typically squashed) by a maintainer.

PR titles follow the convention Group - Summary, for example Modeling - Fix crash in BRepAlgoAPI_Fuse on null shapes.

See the Contribution Workflow and Git Guide for full details.

Contribute Ideas

Every big thing starts with an idea. We appreciate your vision on how to enhance Open CASCADE Technology. Share your thoughts on the OCCT development forum or GitHub Discussions, and submit bug reports or feature requests via GitHub Issues using the provided issue templates.

Forum: OCCT development forum
Discussions: GitHub Discussions
Reporting Issues: GitHub Issues

Contribute Knowledge

Know a lot about OCCT? You can help educate other OCCT users by writing OCCT-related articles or blog posts, creating samples, examples or tutorials, and even by writing a book about OCCT. If you would like us to share your content via official OCCT resources, please contact us.

Contribute Documentation and Tutorials

Do you have an idea on how to make OCCT documentation easier for new users or more exhaustive for professionals? Want to help with proofreading and technical writing? Translating OCCT documentation and materials into your native language is also very much appreciated. Submit documentation improvements as Pull Requests against files under dox/, or open a GitHub Issue describing what you would like to see improved.

Contribute to the Community

At any community interaction point, we value your support in starting forum topics or replying to other users' posts, joining Open CASCADE social networks, participating in GitHub or Stack Overflow projects, and just spreading the word about OCCT. Welcome to our community!

3.6 KiB Raw Blame History