Table of Contents

Contributing to Korpi Engine Code

Unsure where to begin contributing to Korpi? You can start by looking through the Good first issue and Help wanted issue issues.


How can I contribute to the source?

  1. Fork the Repository:

  2. Clone the Repository:

    • Clone the forked repository to your local machine.
      git clone https://github.com/your-username/KorpiEngine.git
      
  3. Create a Branch:

    • Create a new branch for your contribution. Name the branch according to the type of contribution you are making.
    • Naming guide
      git checkout -b feat-your-feature
      
  4. Make Changes:

    • Implement the changes or new features in your branch.
    • Ensure your code follows the project's coding standards.
  5. Test Your Changes:

    • Test your changes thoroughly to make sure they work as expected.
    • If applicable, update or create tests to cover your code.
  6. Commit Your Changes:

    • Commit your changes with a clear and descriptive commit message.
    • Use the present tense ("Add feature" not "Added feature")
      git commit -m "Add feature: your feature description"
      
  7. Push Changes:

    • Push your changes to your forked repository.
      git push origin feature-your-feature
      
  8. Create a Pull Request:

    • Open a pull request (PR) from your branch to the main repository's master branch.
    • Provide a detailed description of your changes in the pull request.
    • Reference any relevant issues in the description.
  9. Code Review:

    • Participate in the code review process, address any feedback, and make necessary changes.
  10. Merge:

  • Once your changes are approved, they will be merged into the main repository.