Skip to content

Latest commit

 

History

History
107 lines (68 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

107 lines (68 loc) · 2.85 KB

Contributing to 3D Model Viewer for Android

Thank you for considering contributing to our project! Your contributions are highly appreciated. Here are some guidelines to help you get started.

Table of Contents

Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming environment for everyone.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please create an issue on GitHub with the following details:

  • A clear and descriptive title
  • A detailed description of the problem
  • Steps to reproduce the issue
  • Any screenshots or logs that might help

Suggesting Features

If you have an idea for a new feature or an enhancement, please create an issue on GitHub with the following details:

  • A clear and descriptive title
  • A detailed description of the proposed feature
  • Any additional information or context

Submitting Pull Requests

  1. Fork the Repository

    Fork the repository to your own GitHub account and then clone it to your local device:

    git clone https://github.com/yourusername/learnopengl.git
cd learnopengl

  2. Create a New Branch

    Create a new branch for your changes:

    git checkout -b feature/your-feature-name

  3. Make Changes

    Make your changes in the new branch. Please follow the Code Style guidelines.

  4. Commit Changes

    Commit your changes with a clear and descriptive commit message:

    git commit -m "Add feature: your feature description"

  5. Push to the Branch

    Push your changes to your forked repository:

    git push origin feature/your-feature-name

  6. Create a Pull Request

    Open a pull request to the main repository. Please include the following in your pull request description:

    • A clear and descriptive title
    • A detailed description of your changes
    • Any related issues or pull requests

Style Guides

Code Style

  • Follow the existing code style in the project.
  • Use meaningful variable and function names.
  • Keep your code clean and well-documented.

Commit Messages

  • Use clear and descriptive commit messages.
  • Follow the convention: type: description. For example, fix: resolve issue with model loading.

Additional Resources

Thank you for your contributions!