Skip to content

Contribution Guidelines

We appreciate your interest in contributing to CrossGL. By contributing, you help improve the project and make it more robust and useful for everyone.

<div class="large-text">How to Contribute</div>

1. Fork the Repository

Start by forking the CrossGL repository on GitHub to your own account.

2. Clone Your Fork

Clone your forked repository to your local machine.

git clone https://github.com/your-username/CrossGL.git
cd CrossGL

3. Create a Branch

Create a new branch for your changes. Use a descriptive name for your branch.

git checkout -b feature-name

4. Make Changes

Make your changes to the codebase. Follow the project\'s coding style and guidelines. Ensure that your changes do not break existing functionality.

5. Add Tests

If applicable, add tests for your changes. Ensure that all tests pass before submitting your contribution.

6. Commit Your Changes

Commit your changes with a clear and concise commit message.

git add .
git commit -m "Description of your changes"

7. Push to GitHub

Push your changes to your forked repository on GitHub.

git push origin feature-name

8. Open a Pull Request

Open a pull request on the original repository. Provide a detailed description of your changes and any additional information that may be useful for the reviewers.

<div class="large-text">Contribution Pipeline</div>

  1. Issue Tracking

    We use GitHub issues to track bugs, enhancements, and tasks. Feel free to open a new issue if you find a bug or have a feature request.

  2. Code Review

    All contributions go through a code review process. The maintainers will review your pull request and provide feedback. Be prepared to make additional changes based on the feedback.

  3. Continuous Integration

    We use Continuous Integration (CI) to run automated tests on all pull requests. Ensure that your code passes all the tests before submitting your pull request.

  4. Merging

    Once your pull request has been reviewed and approved, it will be merged into the main branch.

<div class="large-text">Thank You ✨</div>

Thank you for your interest in contributing to CrossGL! Your contributions make a significant impact on the project and the community.