Skip to content
This repository has been archived by the owner on Dec 14, 2024. It is now read-only.

Latest commit

 

History

History
120 lines (82 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

120 lines (82 loc) · 2.55 KB

Contributing to Demo RPG

Thanks for your interest in contributing. We welcome contributions from everyone. Here's how you can help:

Getting Started

  1. Fork the repository

  2. Clone your fork:

    git clone https://git.konpeki.co.uk/root/work.git

  3. Create a new branch for your changes:

    git checkout -b feature/your-feature-name

Making Changes

Code Style

  • Use consistent indentation (4 spaces)
  • Follow existing naming conventions
  • Add XML documentation comments for public methods
  • Keep methods focused and concise
  • Use meaningful variable and method names (self-documenting code)

Commits

  • Use clear, descriptive commit messages
  • Each commit should represent a single logical change
  • Reference any relevant issue numbers

Pull Requests

  1. Update your fork to the latest upstream version
  2. Test your changes thoroughly
  3. Update documentation if needed
  4. Push to your fork and submit a pull request
  5. Describe your changes in detail
  6. Link any related issues

Areas for Contribution

Code

  • Bug fixes
  • Performance improvements
  • New features
  • Code cleanup and refactoring

Lua Commands

  • New gameplay commands
  • Improvements to existing commands
  • Command utilities and helpers

Documentation

  • Code comments
  • README improvements
  • Wiki pages
  • Tutorials and guides

Localization

  • New language translations
  • Improvements to existing translations
  • Translation fixes

Development Setup

  1. Install .NET 9.0 SDK
  2. Install your preferred IDE (Visual Studio, VS Code, etc.)
  3. Restore NuGet packages
  4. Build the project
  5. Run tests if available

Testing

  • Add tests for new features
  • Ensure existing tests pass
  • Test on different platforms if possible
  • Verify localization works

Questions?

  • Open an issue for discussion
  • Ask for clarification on pull requests
  • Check existing issues and pull requests

Code of Conduct

Please note that this project follows a Code of Conduct. By participating, you are expected to uphold this code.

Our Standards

  • Be respectful and inclusive
  • Accept constructive criticism
  • Focus on what's best for the community
  • Show empathy towards others

Unacceptable Behavior

  • Harassment or discrimination
  • Trolling, insulting, or derogatory comments
  • Public or private harassment
  • Publishing others' private information

Recognition

Contributors will be:

  • Listed in CONTRIBUTORS.md
  • Mentioned in release notes for significant contributions
  • Thanked in commit messages

Thanks for your help! We look forward to your contributions.