Skip to content

Latest commit

 

History

History
91 lines (68 loc) · 3.52 KB

README.md

File metadata and controls

91 lines (68 loc) · 3.52 KB
Raw

Contributing to Raylib Ludo Project

Thank you for your interest in contributing to the Raylib Ludo project! We welcome contributions from anyone who wants to help improve the game, whether you're a seasoned developer or a newcomer. This guide will help you get started with the contribution process.

Table of Contents

Getting Started

  1. Set Up Your Development Environment
    • Make sure you have Raylib installed on your machine. You can find the installation instructions in the Raylib documentation.
    • Clone the repository to your local machine: 
      git clone https://github.com/your_username/raylib-ludo.git
cd raylib-ludo

Choosing an Issue

  1. Check the Issues Tab

    • Visit the Issues tab of the repository to see available issues.
    • Look for issues labeled as good first issue or help wanted if you are new to the project.

  2. Comment on the Issue

    • Once you find an issue you want to work on, leave a comment indicating your interest in tackling it. This will help avoid duplicate work.

  3. Discuss Your Approach (Optional)

    • If you're unsure about your approach, feel free to ask questions in the issue comments. Collaboration is encouraged!

Forking the Repository

  1. Fork the Repository

    • Click the "Fork" button in the upper right corner of the repository page to create your copy of the project.

  2. Clone Your Fork

    • Clone your forked repository to your local machine: 
      git clone https://github.com/yourusername/raylib-ludo.git
cd raylib-ludo

Making Changes

  1. Create a Branch

    • Create a new branch for your changes. Use a descriptive name for the branch: 
      git checkout -b issue-branch-name

  2. Make Your Changes

    • Implement the changes needed to resolve the issue you picked. Ensure you follow the project's coding style and conventions.

  3. Test Your Changes

    • Run the game and test your changes to ensure everything works as expected.

  4. Commit Your Changes

    • Once you are happy with your changes, commit them with a descriptive message: 
      git add .
git commit -m "Fixes #issue_number: Description of the fix"

Submitting a Pull Request

  1. Push Your Changes

    • Push your changes to your forked repository: 
      git push origin issue-branch-name

  2. Create a Pull Request

    • Go to the original repository and click the "New Pull Request" button.
    • Select your branch and provide a clear description of your changes. Reference any issues you are addressing (e.g., "Fixes #issue_number").

  3. Review Process

    • Once submitted, your pull request will be reviewed. Be open to feedback and ready to make any necessary changes.

Additional Resources

Thank you for your interest in contributing to the Raylib Ludo project! We look forward to your contributions.