|
| 1 | +# CONTRIBUTING.md |
| 2 | + |
| 3 | +We welcome contributions to the `@interactive-video-labs/react` project! By contributing, you help us improve and expand the capabilities of this React wrapper for interactive video experiences. Please take a moment to review this document to understand how to contribute effectively. |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | + |
| 7 | +1. [Code of Conduct](#1-code-of-conduct) |
| 8 | +2. [How Can I Contribute?](#2-how-can-i-contribute) |
| 9 | + * [Reporting Bugs](#reporting-bugs) |
| 10 | + * [Suggesting Enhancements](#suggesting-enhancements) |
| 11 | + * [Your First Code Contribution](#your-first-code-contribution) |
| 12 | + * [Pull Request Guidelines](#pull-request-guidelines) |
| 13 | +3. [Development Setup](#3-development-setup) |
| 14 | +4. [Testing](#4-testing) |
| 15 | +5. [Coding Style](#5-coding-style) |
| 16 | +6. [Commit Messages](#6-commit-messages) |
| 17 | +7. [License](#7-license) |
| 18 | + |
| 19 | +## 1. Code of Conduct |
| 20 | + |
| 21 | +This project adheres to the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [your contact email or issue tracker]. |
| 22 | + |
| 23 | +## 2. How Can I Contribute? |
| 24 | + |
| 25 | +### Reporting Bugs |
| 26 | + |
| 27 | +If you find a bug, please open an issue on our [GitHub Issues](https://github.com/interactive-video-labs/interactive-video-react-wrapper/issues) page. When reporting a bug, please include: |
| 28 | + |
| 29 | +* A clear and concise description of the bug. |
| 30 | +* Steps to reproduce the behavior. |
| 31 | +* Expected behavior. |
| 32 | +* Actual behavior. |
| 33 | +* Screenshots or video (if applicable). |
| 34 | +* Your environment details (OS, browser, `@interactive-video-labs/react` version, React version). |
| 35 | + |
| 36 | +### Suggesting Enhancements |
| 37 | + |
| 38 | +We love new ideas! If you have a suggestion for an enhancement or a new feature, please open an issue on our [GitHub Issues](https://github.com/interactive-video-labs/interactive-video-react-wrapper/issues) page. Please include: |
| 39 | + |
| 40 | +* A clear and concise description of the proposed enhancement. |
| 41 | +* Why this enhancement would be useful. |
| 42 | +* Any potential use cases or examples. |
| 43 | + |
| 44 | +### Your First Code Contribution |
| 45 | + |
| 46 | +If you're looking to make your first code contribution, look for issues labeled `good first issue` on our [issue tracker](https://github.com/interactive-video-labs/interactive-video-react-wrapper/issues). |
| 47 | + |
| 48 | +### Pull Request Guidelines |
| 49 | + |
| 50 | +1. **Fork the repository** and create your branch from `main`. |
| 51 | +2. **Ensure your code adheres to the existing style** (see [Coding Style](#5-coding-style)). |
| 52 | +3. **Add or update tests** for any new features or bug fixes. Ensure all tests pass. |
| 53 | +4. **Update documentation** as necessary (e.g., `README.md`, `DEVELOPER.md`). |
| 54 | +5. **Write clear and concise commit messages** (see [Commit Messages](#6-commit-messages)). |
| 55 | +6. **Open a pull request** to the `main` branch. Provide a clear description of your changes and reference any related issues. |
| 56 | + |
| 57 | +## 3. Development Setup |
| 58 | + |
| 59 | +For detailed instructions on setting up your development environment, installing dependencies, and running the project locally, please refer to the [DEVELOPER.md](DEVELOPER.md) file. |
| 60 | + |
| 61 | +## 4. Testing |
| 62 | + |
| 63 | +All new features and bug fixes should be accompanied by appropriate tests. To run the test suite, use: |
| 64 | + |
| 65 | +```bash |
| 66 | +pnpm test |
| 67 | +``` |
| 68 | + |
| 69 | +Ensure all tests pass before submitting a pull request. |
| 70 | + |
| 71 | +## 5. Coding Style |
| 72 | + |
| 73 | +We use ESLint and Prettier to maintain a consistent coding style. Please ensure your code is formatted correctly before submitting a pull request. You can typically run linting and formatting checks via your IDE or by running project-specific scripts (if available, check `package.json`). |
| 74 | + |
| 75 | +## 6. Commit Messages |
| 76 | + |
| 77 | +We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for our commit messages. This helps with automated changelog generation and understanding the history of changes. |
| 78 | + |
| 79 | +Examples: |
| 80 | + |
| 81 | +* `feat: Add new video playback controls` |
| 82 | +* `fix: Resolve issue with cue point triggering` |
| 83 | +* `docs: Update README with new usage example` |
| 84 | +* `chore: Update dependencies` |
| 85 | + |
| 86 | +## 7. License |
| 87 | + |
| 88 | +By contributing to `@interactive-video-labs/react`, you agree that your contributions will be licensed under its MIT License. See the [LICENSE](LICENSE) file for details. |
0 commit comments