## Contributing to Vent Engine

You're interested in contributing to Vent Engine?, This guide outlines the process for submitting code contributions and participating in the project.

## Getting Started

- **Fork the Repository: Create a fork of the Vent Engine repository on GitHub.**
- **Clone your Fork: Clone your forked repository to your local machine.**
- **Create a Branch: Create a new branch for your contribution. Use a descriptive branch name that reflects your changes.**
- **Install the Rust programming Language at [here](https://www.rust-lang.org/tools/install)**

## Making Changes

- **[Install Dependencies](#install-dependencies): Make sure you have all the necessary dependencies installed to build and run Vent Engine**
- **Code Style: Follow the existing code style conventions used in the project. This ensures consistent and maintainable code.**
- **Write Clean Code: Write clear, concise, and well-documented code.**

## Submitting your Contribution

- **Make sure your Code does Compile fine**
- **Run `cargo fmt`**
- **Fix any warnings your change produced when running `cargo check`.**
- **Commit Changes: Commit your changes with informative commit messages that describe the purpose of your modifications.**
- **Push your Branch: Push your branch to your forked repository on GitHub.**
- **Create a Pull Request: Create a pull request from your branch to the main branch of the upstream Vent Engine repository.**

## Install Dependencies

**For all Platforms you will need to install the [Vulkan SDK](https://vulkan.lunarg.com/sdk/home)**

- [Windows](#windows)
- [Linux](#linux)

### Windows

- Windows SDK (Note: usually comes in Visual Studio Installer when installing Rust)

### Linux

- Wayland (or XWayland)
- xkbcommon (libxkbcommon)

## Additional Notes

- Issues: Feel free to create issues on the GitHub repository for bugs, feature requests, or discussions.
- Community: We encourage you to participate in the community discussions and help others using Vent Engine.