Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (37 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

50 lines (37 loc) · 1.75 KB

Contributing to GeneralUpdate

Thank you for your interest in contributing to GeneralUpdate! We welcome contributions from the community.

How to Contribute

Reporting Issues

  • Use the GitHub Issues tab to report bugs or suggest features.
  • Check if a similar issue already exists before creating a new one.
  • Provide as much detail as possible: steps to reproduce, environment info, screenshots if applicable.

Submitting Changes

  1. Fork the repository.
  2. Create a feature branch from main: 
    git checkout -b feat/your-feature-name
  3. Make your changes, following the coding style of the existing codebase.
  4. Write or update tests to cover your changes.
  5. Ensure all tests pass by running the test suite.
  6. Commit your changes with a clear commit message: 
    feat: add support for xxx
fix: resolve issue with xxx
docs: update readme for xxx
  7. Push to your fork and submit a Pull Request.
  8. In your PR description, explain what the change does and why it is needed.

Pull Request Guidelines

  • Keep PRs focused on a single concern. If you have multiple unrelated changes, submit separate PRs.
  • Ensure your code builds cleanly and passes all tests.
  • Update documentation if your change affects public APIs or usage.
  • Be responsive to review feedback. We aim to review PRs within one week.

Code Style

  • Follow the existing coding conventions used in the project.
  • Use consistent indentation (spaces, 4 per level).
  • Add XML documentation comments for public APIs.
  • Run dotnet format before committing if possible.

Questions?

If you have questions, feel free to open a Discussion on GitHub or reach out via Discord (server link available on the project website).

Thank you for contributing!