Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

49 lines (29 loc) · 1.55 KB
Raw

How to contribute to this project

First, thank you for being interested in this project and willing to do some contributions.

Content

Code Style

Please obey our Code Style Guide to maintain code consistency

Commit Changes

If you want to commit changes,please obey the following steps:

  1. Fork the project from main.
  2. Create a new branch to develop.
  3. Make sure that you code follow our code style.
  4. Commit your changes to your fork.
  5. Create a Pull Request(PR) to our main branch.

Tests

For your code,you should write necessary tests to cover your code in both GDScript and Rust.We use Github Action to run the tests

Rust Test Guide

We will run some Godot scenes to check basic errors.The scenes should be ran is recorded in test_scene.In daily development,you can run script/godot_test.pyto conduct basic testing

We also provide several functions to test the development of the project,listing;

  • You can create file debug/sword ,and write down the name of the sword should be tested.This file will be read automatically and this sword will be run immediately

Version Control

Please write your commit message in Conventional Commits。

Other Resource

We are looking forward to your contributions and hope that you can gain joy and sense of achievement