When contributing to the Kanda SDK, it is crucial to ensure that all changes meet the following criteria before they can be submitted for review and merged into the main branch.

Functional Code

The written code should be functional and error-free. It should be complete within the scope of the intended functionality.

No Compiler Warnings

Warning fatigue can prevent discovery of real issues. Avoid creating new compiler warnings when changing the code.

Coding Standards

The code should adhere to our established coding and quality standards. It should align with our design principles to maintain consistency and quality across the codebase.

XML Documentation

The code should include C# XML docs. This documentation is essential for generating the Scripting API docs and should be detailed, helpful and accurate.

User Manual

For new features or additions to existing features, you should create or update the user manual. The manual should be written in markdown format within the Documentation~ folder and should clearly explain the changes.

Automated Tests

Ensure a good coverage of unit or component tests for the new features. If modifications are made to existing features, corresponding tests should be updated or added to maintain test coverage.

By adhering to these criteria, we ensure that the Kanda SDK remains reliable, maintainable, and user-friendly.