Skip to content

Add contributing guide #401

@budak7273

Description

@budak7273

Document should cover:

  • The structure of this repo
  • Expectations for testing
    • Content should work on windows clients, windows servers, linux servers
    • Test locally on all the platforms you can before opening a PR
  • Expectations for implementing things in blueprint versus c++
  • Code style (UE Style)
  • Discuss on the Discord with the team first - not all features belong in SML
    • Examples of things that usually do:
      • Hooking enhancements
      • General systems to improve cross-mod compatibility
      • Access transformers or blueprint-callable helpers for C++ functions that would benefit every mod trying to extend the game
      • ExampleMod examples of SML or base-game features
      • Developer utilities in SMLEditor
    • Examples of things that usually don't:
  • Supporting merged content
    • We won't merge changes that we can't reasonably support in the future

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    Status

    📋 Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions