occt/.github/CONTRIBUTING.md

Contributing to OCCT

Contribute Code

In order to contribute code to OCCT, you must register on this portal and sign the Contributor License Agreement (CLA).

• Introduction: What is CLA and Why It Is Needed?
• Contribution License Agreement
• CLA Submission Form

Steps to Submit Your Contribution

1. Clone OCCT Git Repository: See Guide to installing and using Git for OCCT development if you are not familiar with Git.
2. Develop Your Change: Ensure it complies with OCCT Coding Rules.
3. Build and Verify: Build the modified version of OCCT and verify it works as expected. Consider creating a test case.
4. Register an Issue: Register an issue in the Mantis bug tracker or GitHub issues describing your change.
5. Push Your Change: Push your change to the Git repository in a branch with a name starting with "CR" followed by the issue ID, then switch the issue to Resolved.

The contribution then passes code review and testing; if everything is OK, it will be integrated into the master branch in about one week.

See Contribution Workflow for other possibilities and details on how contributions are processed.

For more details on integration into GitHub, see the GitHub Discussions Guide.

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 product development forum or submit your meaningful ideas and bug reports via Mantis tracker or GitHub issues.

• Forum: OCCT product development forum
• Reporting Issues: Mantis tracker or 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 even more exhaustive for professionals? Or want to help with proofreading and technical writing? Translating OCCT Documentation and materials into your native language is also very much appreciated. You are always welcome to submit your documentation improvement suggestions via Mantis tracker or GitHub issues..

Contribute to the Community

At any community interaction points, 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!