Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 3.59 KB

Contributing to FPS Game Game

Welcome to FPS Game! We appreciate your interest in contributing to our project. Please take a moment to read through this guide to understand how you can help us make this game even better.

Table of Contents

Getting Started

Before you start contributing to FPS Game, please make sure you have:

Reporting Bugs

If you encounter a bug or unexpected behavior in the game, please check if it has already been reported by searching the Issues. If it hasn't been reported yet, feel free to open a new issue (using the Bug Report issue template) and provide as much detail as possible.

Requesting Features

Have an idea for a new feature or improvement? We encourage you to discuss it with the community first by opening a Feature Request template issue. This way, you can gather feedback and refine your proposal before investing time in development.

Contributing Code

Development Setup

  1. Fork the repository to your own GitHub account;
  2. Clone your fork to your local machine;
  3. Set up the Godot project using the Godot 4 version;
  4. Create a new branch for your contribution: git checkout -b 123-my-issue-title, check here for branch name convention;
  5. Make your changes, test them thoroughly, and ensure they adhere to the project's code style;

Code Style

Please follow our Coding Guidelines/Code Styles to maintain consistency in the codebase. We recommend using Godot's scripting language best practices and adhering to the GDScript style guide.

Submitting a Pull Request

  1. Ensure your changes are on a feature branch, not the main branch;
  2. Commit your changes with clear and concise messages, check here commit message convections;
  3. Push your branch to your GitHub fork: git push origin 123-my-issue-title, check here for branch name convention;
  4. Create a Pull Request (PR) from your branch to the main project repository, Check here for pull request best practices;
  5. Our team will review your PR, offer feedback, and merge it if it meets our guidelines;

Community and Communication

We value your feedback and contributions to FPS Game. If you have questions or need help, please don't hesitate to reach out:

Thank you for considering contributing to FPS Game. Your help is greatly appreciated, and it will contribute to making our game a success, and you will forever be in our hearts and on the list of contributors.