Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.22 KB
Raw

Contributing Guidelines

First off, thank you for considering contributing to Trakt.NET.

Trakt.NET is an open source project and there are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing new feature implementations which can be incorporated into Trakt.NET.

Please do not use the issue tracker for support questions. If you have questions regarding on how to use the library, start a discussion.

Getting started

  1. Create your own fork of the repository
  2. Do the changes in your fork
    • Create a branch for the change with a descriptive name.
  3. If you like your change, send a pull request

Build Requirements

  • at least Visual Studio 2017 with support for C# 7.2

Which branch should I target?

By default you should target the branch develop. If you're working on an issue, usually the issue would have a label "target-branch", which states the branch to target for that specific issue.

Please DO NOT target the main branch.

General Requirements

  • Do not make big surprise pull requests with a lot of changes and without an associating issue.
    • First, please open a discussion, whether your changes do make an actual improvement.
  • Pull requests that do not merge easily with the tip of the targeted branch will be needed to merge with the tip of the targeted branch to update the pull request.
  • Submissions must follow the rules stated in the Coding Guidelines.
  • New features must have accompanying tests with "good" code coverage.
  • Changes to existing functionality needs to be checked that it does not break any existing unit tests.

Cross-platform compatibility

  • Trakt.NET is built against .NET Standard 2.0