Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (56 loc) · 3.86 KB

CONTRIBUTING.md

File metadata and controls

56 lines (56 loc) · 3.86 KB

Contributing to UltimateServer

We welcome contributions to UltimateServer! This guide will help you get started. Whether you're fixing a bug, implementing a new feature, or improving documentation, your help is appreciated.

How to Contribute

Reporting Bugs

If you find a bug, please report it by creating an issue on our GitHub Issues page.

A good bug report includes:

  • A clear and descriptive title.
  • Steps to reproduce the behavior.
  • The expected behavior.
  • The actual behavior (including error messages, if any).
  • Your environment details (OS, .NET version, etc.).

Suggesting Features

Have an idea for a new feature? We'd love to hear it!

  • First, check the existing issues to make sure it hasn't already been suggested.
  • Create a new issue using the "Feature Request" template if available.
  • Provide a clear description of the feature and why it would be useful.

Submitting Changes (Pull Requests)

Follow these steps to submit your code changes:

  1. Fork the repository: Click the "Fork" button on the top right of the project page.
  2. Create a feature branch: In your forked repository, create a new branch for your change. 
    git checkout -b feature/AmazingFeature
  3. Make your changes: Implement your bug fix or new feature. Please follow our code style guidelines.
  4. Commit your changes: Write a clear and concise commit message. 
    git commit -m 'Add some AmazingFeature'
  5. Push to the branch: Push your changes to your forked repository. 
    git push origin feature/AmazingFeature
  6. Open a Pull Request: Go to the original repository and click "New Pull Request". Select your branch and provide a detailed description of your changes.

Development Setup

To set up a development environment:

  1. Follow the Installation Guide to get the server running.
  2. Clone your forked repository locally.
  3. Open the project in your preferred C# IDE (Visual Studio, VS Code, Rider).
  4. Ensure you have the .NET 8.0 SDK installed.

Code Style

We aim for clean, readable, and maintainable code. Please follow these general guidelines:

  • Adhere to the Microsoft C# coding conventions.
  • Use meaningful variable and method names.
  • Add comments where the logic is complex or non-obvious.
  • Keep methods and classes small and focused on a single responsibility.

License

By contributing, you agree that your contributions will be licensed under the same license as the project. Please see the LICENSE file for details.

Community

We strive to create a welcoming and inclusive community. Please be respectful and constructive in all interactions. Thank you for contributing!