|
| 1 | +# Contributing to Processing Collaborative Editor |
| 2 | + |
| 3 | +We welcome contributions to the Processing Collaborative Editor project! This document outlines the process for contributing to the repository through pull requests. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +1. Fork the repository on GitHub. |
| 8 | +2. Clone your fork locally: |
| 9 | + ``` |
| 10 | + git clone https://github.com/your-username/processing-collaborative-editor.git |
| 11 | + ``` |
| 12 | +3. Create a new branch for your feature or bug fix: |
| 13 | + ``` |
| 14 | + git checkout -b feature/your-feature-name |
| 15 | + ``` |
| 16 | + |
| 17 | +## Making Changes |
| 18 | + |
| 19 | +1. Make your changes in the new branch. |
| 20 | +2. Commit your changes with a clear and descriptive commit message: |
| 21 | + ``` |
| 22 | + git commit -m "Add feature: your feature description" |
| 23 | + ``` |
| 24 | +3. Push your changes to your fork on GitHub: |
| 25 | + ``` |
| 26 | + git push origin feature/your-feature-name |
| 27 | + ``` |
| 28 | + |
| 29 | +## Creating a Pull Request |
| 30 | + |
| 31 | +1. Go to the original repository on GitHub. |
| 32 | +2. Click on "Pull requests" and then the "New pull request" button. |
| 33 | +3. Click "compare across forks" and select your fork and branch. |
| 34 | +4. Review the changes and click "Create pull request". |
| 35 | +5. Fill out the pull request template with a clear title and description of your changes. |
| 36 | +6. Submit the pull request. |
| 37 | + |
| 38 | +## Pull Request Guidelines |
| 39 | + |
| 40 | +- Ensure your code follows the project's coding standards and style guidelines. |
| 41 | +- Include tests for new features or bug fixes. |
| 42 | +- Update documentation if necessary. |
| 43 | +- Make sure all tests pass before submitting the pull request. |
| 44 | +- Keep pull requests focused on a single feature or bug fix. |
| 45 | + |
| 46 | +## Code Review Process |
| 47 | + |
| 48 | +1. Maintainers will review your pull request. |
| 49 | +2. They may request changes or ask questions. |
| 50 | +3. Make any necessary updates to your branch and push the changes. |
| 51 | +4. Once approved, a maintainer will merge your pull request. |
| 52 | + |
| 53 | +Thank you for contributing to the Processing Collaborative Editor project! |
0 commit comments