Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.6 KB
Raw

Contributing

This file outlines guidelines for contributing to the project. It includes information on how to report issues, suggest improvements, submit pull requests, and adhere to the project's coding standards or community guidelines.

Guidelines

It is not the goal of this project to match retail behavior exactly. Changes to improve the login experience are encouraged.

Reporting Issues

  1. Open a new issue in GitHub and include as much detail as possible to assist in reproducing the issue.
  2. Optionally, add a label to your issue that makes sense to you.

Suggesting Improvements

  1. Open a new issue in GitHub and include as much detail as possible to assist in fulfilling the suggested improvement.
  2. Add the enchancement label to your issue.

Pull Requests (PR)

  1. Are required for any change to be accepted.
  2. Must describe the functionality that fixes an issue or improves the code.
  3. If the change is worth mentioning, update the CHANGELOG.md.
  4. Check that the change might cause a README.md update, and make it if so.
  5. Do not make PRs to remove functionality that retail does not necessarily support. It is likely that such things have settings to enable or disable.

Coding Standards

Generally the following standards are applied, but you may notice private, static, thread static members do not use prefixes. Please avoid prefixes to variable names.

  1. C# Coding Conventions by Microsoft

Definitions

  • retail - refers to the public version of the game