| 1 | # Contributing to ALLWEONE Presentation Generator |
| 2 | |
| 3 | Thank you for your interest in contributing to the ALLWEONE Presentation Generator! This document provides guidelines and instructions for contributing to this project. |
| 4 | |
| 5 | ## Code of Conduct |
| 6 | |
| 7 | By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others. |
| 8 | |
| 9 | ## Getting Started |
| 10 | |
| 11 | 1. **Fork the repository** on GitHub |
| 12 | 2. **Clone your fork** |
| 13 | |
| 14 | ```bash |
| 15 | git clone git@github.com:allweonedev/presentation-ai.git |
| 16 | cd presentation-ai |
| 17 | ``` |
| 18 | |
| 19 | 3. **Set up the development environment** |
| 20 | |
| 21 | ```bash |
| 22 | pnpm install |
| 23 | ``` |
| 24 | |
| 25 | 4. **Create a new branch** for your contribution |
| 26 | |
| 27 | ```bash |
| 28 | git checkout -b feature/your-feature-name |
| 29 | ``` |
| 30 | |
| 31 | ## Development Workflow |
| 32 | |
| 33 | 1. Make your changes locally |
| 34 | 1. Follow the code style guidelines |
| 35 | 1. Commit your changes using clear commit messages |
| 36 | 1. Push your branch to your fork |
| 37 | 1. Open a pull request from your fork to the main repository |
| 38 | |
| 39 | ## Pull Request Process |
| 40 | |
| 41 | 1. **Use a clear and descriptive title** for your PR |
| 42 | 1. **Include a detailed description** explaining what your changes do and why they should be included |
| 43 | 1. **Link any related issues** using GitHub issue references |
| 44 | 1. Wait for a maintainer to review your PR |
| 45 | 1. Address any feedback from reviewers |
| 46 | 1. Once approved, a maintainer will merge your PR |
| 47 | |
| 48 | ## Coding Standards |
| 49 | |
| 50 | - Follow the existing code style in the project |
| 51 | - Use meaningful variable and function names |
| 52 | - Write clear comments for complex logic |
| 53 | - Keep functions focused on a single responsibility |
| 54 | - Follow TypeScript best practices and maintain type safety |
| 55 | |
| 56 | ## Commit Guidelines |
| 57 | |
| 58 | We follow conventional commit messages: |
| 59 | |
| 60 | - `feat:` for new features |
| 61 | - `fix:` for bug fixes |
| 62 | - `docs:` for documentation changes |
| 63 | - `style:` for formatting changes |
| 64 | - `refactor:` for code refactoring |
| 65 | - `chore:` for changes to the build process or auxiliary tools |
| 66 | |
| 67 | ## Issue Reporting |
| 68 | |
| 69 | If you find a bug or have a feature request: |
| 70 | |
| 71 | 1. Check if it already exists in the [Issues](https://github.com/allweonedev/presentation-ai/issues) |
| 72 | 2. If not, create a new issue using the appropriate template |
| 73 | 3. Provide detailed steps to reproduce bugs |
| 74 | 4. For feature requests, explain the use case and benefits |
| 75 | |
| 76 | ## Questions or Need Help? |
| 77 | |
| 78 | If you have questions or need help, you can: |
| 79 | |
| 80 | - Open a discussion on GitHub |
| 81 | - Reach out via the project's communication channels ([Discord](https://discord.gg/fsMHMhAHRV) / [Issues](https://github.com/allweonedev/presentation-ai/issues)) |
| 82 | |
| 83 | ## License |
| 84 | |
| 85 | By contributing to this project, you agree that your contributions will be licensed under the project's [MIT License](LICENSE). |
| 86 | |
| 87 | Thank you for contributing to make ALLWEONE Presentation Generator better for everyone! |
| 88 |