Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (43 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 2.92 KB
Raw

Contributing to the Enjin Platform C# SDK

Contributions are appreciated. You may contribute to this SDK by filing issues or opening pull requests (PRs).

Reporting Issues

Bug reports, API proposals, and feedback in general are always welcomed.

Check for Existing Issues

Before opening a new issue, please search open issues to check if it already exists.

If the issue already exists, then please consider adding contributing feedback in the discussion.

API Proposals

API proposals are welcomed, however do consider if the API proposal is isolated at the SDK level or involves some other component of the ecosystem.

Reporting Bugs

Before reporting a bug, please consider if it is a bug within the SDK or a bug somewhere else in the ecosystem that the SDK interacts with. For example, before creating a bug report that focuses on a particular GraphQL request, consider testing the same request in your platform's GraphiQL development environment (with the same exact parameters if possible) and compare the behavior there against the SDK.

A bug report should contain the following information:

  • A high-level description of the problem.
  • A minimal reproduction, as in the smallest unit of code or configuration required to reproduce the behavior.
  • A description of the expected behavior and the actual behavior.
  • Environment information: SDK version, OS, C#/.NET version, etc.
  • Additional information, such as whether it worked in a previous version or if there are any workarounds.

⚠️ Do not include any sensitive information in your bug report(s), e.g. your Enjin Platform's authorization tokens.

Contributing Changes

Project maintainers will merge changes that significantly improve the SDK.

DOs and DON'Ts

Please do:

  • DO include documentation when adding new type or methods.
  • DO include tests when adding new features that are not fully dependent on a third-party library used by the SDK.
    • For example, it is acceptable to forgo testing when it comes to de/serializing type models.
  • DO keep discussions focused. When new topics come up, consider creating a new issue.
  • DO clearly state on an issue whether you are going to take on its implementation.
  • DO blog about or share your contributions on social media.

Please do not:

  • DON'T make PRs for style changes.
  • DON'T make large surprise PRs. Please file an issue to start a discussion so a direction can be agreed upon before commiting a large amount of time.
  • DON'T commit code that you did not write.
  • DON'T submit PRs that alter licensing.

Breaking Changes

Contributions which happen to introduce breaking changes may be considered if they are offset by significant improvements to the API, project structure, or respond to changes in the Platform or .NET ecosystems. However, in contributions which contain breaking changes will generally be discouraged.