Skip to main content
Welcome to the TNB contributing guide! This section will help you get started with contributing to the TNB framework.

Getting started

To minimize the amount of changes in pull requests, TNB uses standardized code style configurations that all contributors should follow.
The code style is enforced through EditorConfig and CheckStyle configurations included in the repository.

Code style tools

TNB uses two main tools to maintain consistent code quality:
1

EditorConfig

Provides basic formatting rules like indentation, line endings, and character encoding across different editors and IDEs.
2

CheckStyle

Enforces Java-specific coding standards including naming conventions, import order, whitespace rules, and code structure.

What’s next?

Ready to set up your development environment? Check out the following guides:
Before submitting a pull request, ensure your code follows all style guidelines to minimize review iterations.

Build docs developers (and LLMs) love