satisfactorymodding / satisfactorymodding/SatisfactoryModLoader

Add contributing guide

Open
#401 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
344
Forks
225
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository structure described in the issue and the linked Starter Project Structure guide. Draft a contributing guide covering testing platforms, Blueprint versus C++, UE style, team discussion, suitable contributions, runtime-test boundaries, and long-term support expectations; it is done when each listed expectation is documented clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, unreal-engine
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.