Welcome, and thank you for considering contributing to TSEconomy! We value your time and effort in helping to improve this Terraria server-side plugin. This document outlines the process and guidelines for contributing.
If you find a bug in the plugin, you can help us by submitting an issue to our GitHub repository. Please follow these steps:
- Use the GitHub issue search — check if the issue has already been reported.
- Check if the issue has been fixed — try to reproduce it using the latest
mainbranch. - Isolate the problem — create a minimal, complete, and verifiable example.
- Submit an issue — Mark the issue as a
bug, and provide a step-by-step instruction set on how to reproduce the bug. If any errors occur, include those too.
We welcome suggestions for enhancements! Open an issue on GitHub and include:
- Use cases for the enhancement - how it will benefit TSEconomy users.
- Possible drawbacks - potential challenges or complications.
Please mark the issue as an enhancement
PRs are the best way to propose changes. Here's a quick guide:
- Fork the repo and create your branch from
main. - Write clear, concise code and adhere to existing coding standards.
- Include tests that demonstrate your bug fix or feature.
- Write a convincing description of your PR and why we should merge it.
- We'll check it out when we get the time!
Our main branch is always stable. We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
- Follow the Microsoft C# Coding Conventions.
- Use meaningful names for variables and methods.
- Comment your code where necessary.
Thank you for reading this guide and for contributing to TSEconomy!