From 5a8707db984a4798a9cd4867ba92b845b176fcf2 Mon Sep 17 00:00:00 2001 From: Sergei Solokhin Date: Sat, 29 Nov 2025 22:50:45 +0000 Subject: [PATCH 1/3] Add Contributor Covenant Code of Conduct This document outlines the standards of behavior expected from community members, including pledges for a harassment-free environment, acceptable and unacceptable behaviors, enforcement responsibilities, and consequences for violations. --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..e31c47e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +neill3d@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. From 486a25a55833d0ca597369c2c651e32d19457fff Mon Sep 17 00:00:00 2001 From: Sergei Solokhin Date: Sat, 29 Nov 2025 23:21:54 +0000 Subject: [PATCH 2/3] Add contributing guidelines for OpenMoBu This document provides guidelines for contributing to OpenMoBu, including reporting issues, requesting features, forking, branching, coding standards, commit message conventions, pull request guidelines, testing, licensing, and code of conduct. --- CONTRIBUTING.md | 172 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 172 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2714c98 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,172 @@ +# Contributing to OpenMoBu + +Thank you for your interest in contributing to **OpenMoBu**! +We welcome improvements in performance, stability, documentation, and new MotionBuilder-related features. +This document explains how to propose changes, follow the code style, and participate in development. + +--- + +## Table of Contents +1. [Reporting Issues](#1-reporting-issues) +2. [Requesting Features](#2-requesting-features) +3. [Forking & Branching Model](#3-forking--branching-model) +4. [Code Style Guidelines](#4-code-style-guidelines) +5. [Commit Message Conventions](#5-commit-message-conventions) +6. [Pull Request Guidelines](#6-pull-request-guidelines) +7. [Testing & Validation](#7-testing--validation) +8. [Licensing](#9-licensing) +9. [Code of Conduct](#10-code-of-conduct) + +--- + +# 1. Reporting Issues + +If you encounter a bug, please open a **GitHub Issue** and include: + +- Clear title +- Steps to reproduce +- Expected vs actual behaviour +- MotionBuilder version (e.g., 2022 / 2023 / 2024) +- OS & GPU info (Windows, NVIDIA driver version, etc.) +- Logs or screenshots (if relevant) + +Before submitting, please search existing issues to avoid duplicates. + +--- + +# 2. Requesting Features + +Feature requests are welcome. When creating a feature request: + +- Clearly describe the need or workflow improvement +- Provide examples (videos, screenshots, use cases) +- Add technical context where possible (API limits, MB SDK details) +- Suggest a potential implementation direction (optional) + +Large features should be discussed before implementation. + +--- + +# 3. Forking & Branching Model + +OpenMoBu uses a simple branching workflow: + +- **master** → stable, production-ready +- **feature/*** → for new features +- **bugfix/*** → for bug fixes +- **docs/*** → documentation updates + +### Steps to contribute + +1. Fork the repository +2. Create a feature branch + ```bash + git checkout -b feature/ + ``` +3. Commit your changes +4. Push to your fork +5. Open a Pull Request against `master` + +--- + +# 4. Code Style Guidelines + +### General +- Use **modern C++17/20** features when appropriate +- Keep functions small and readable +- Avoid unnecessary dynamic allocations in real-time code + +### File Naming +- `.cpp`, `.h`, `.inl` +- PascalCase for classes and methods +- camelCase for class members and variables +- UPPER_CASE for constants + +### Formatting +- 4-space indentation, no tabs + +### Error Handling +- Use assertions for internal logic assumptions +- Avoid exceptions inside real-time render/evaluation loops +- Prefer status return values for predictable control flow + +--- + +# 5. Commit Message Conventions + +Use descriptive commit messages. Recommended format: + +``` +: + +[optional longer explanation] +``` + +**Types:** + +- `feat:` new feature +- `fix:` bug fix +- `perf:` performance improvement +- `refactor:` code cleanup +- `docs:` documentation only +- `build:` build/CI changes +- `test:` tests + +**Example:** + +``` +perf: optimize SSAO kernel sampling and reduce texture lookups +``` + +--- + +# 6. Pull Request Guidelines + +Before opening a PR: + +- Ensure the code builds on supported MotionBuilder versions +- Verify the plugin loads and runs correctly +- Run performance-sensitive features in a simple scene +- Update documentation if the change affects the workflow (optional) +- Add comments for complex GPU or multithreading logic + +Your PR should include: + +- Clear summary of changes +- Screenshots or profiler results if relevant +- Notes about compatibility (MB version, SDK differences) + +Large PRs may be requested to be split. + +--- + +# 7. Testing & Validation + +OpenMoBu plugins interact closely with MotionBuilder. +Before submitting: + +### Functionality checks +- Rebuild the plugin in Release mode +- Load in MotionBuilder +- Test with a minimal scene +- Verify stability across playback, scrubbing, and evaluation cycles + +### Performance checks +- Use internal MotionBuilder's profiler tools or RenderDoc, Nsight, or any GPU profiler +- Avoid regressions in real-time passes (post-processing, compute, etc.) + +--- + +# 8. Licensing + +By contributing, you agree that your code will be released under the project’s license. +Ensure you have rights to contribute the code, especially if it originates from an employer. + +--- + +# 9. Code of Conduct + +This project follows the Contributor Covenant. +Be respectful, constructive, and collaborative. + +--- From 2820f441efbe7f8a5bfcee0c4a1f5b5c68695701 Mon Sep 17 00:00:00 2001 From: Sergei Solokhin Date: Sat, 29 Nov 2025 23:23:11 +0000 Subject: [PATCH 3/3] Update copyright year in LICENSE file --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 21b5a98..d43e0fd 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ The "New" BSD License: ---------------------- -Copyright (c) 2010-2024, Sergei Solokhin (Neill3d) +Copyright (c) 2010-2025, Sergei Solokhin (Neill3d) All rights reserved. Redistribution and use in source and binary forms, with or without