Skip to content

Commit

Permalink
Add Contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
Snowiiii committed Jul 6, 2024
1 parent 59cb5db commit 8784a5e
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 12 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## 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.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [2023] [Alexandr Medvedev]
Copyright [2024] [Alexandr Medvedev]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">

# ⚜️ Vent-Engine ⚜️
# Vent-Engine

**A game engine written in Rust with the goal to be very fast & user-friendly**

Expand Down Expand Up @@ -28,16 +28,9 @@ For the current Development, look at [GitHub Projects](https://github.com/Snowii
**(24.03.2024)**


#### How to contribute?
### How to contribute?

Contributions are welcome in any way, shape, or form. Here's how you can get started:

- Fork the repository and clone it to your local machine.
- Run `cargo run --release --bin vent-runtime` to start the runtime.
- Make your changes and submit a pull request.

Use [GitHub Issues](https://github.com/Snowiiii/Vent-Engine/issues) to report bugs, request
features.
Contributions are welcome in any way, shape, or form. See [Contributing](CONTRIBUTING) to know how you can get started:

### 🎮 Platforms

Expand Down

0 comments on commit 8784a5e

Please sign in to comment.