Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (53 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

69 lines (53 loc) · 1.92 KB
Raw

Contributing to UEFNiVERSE

Thanks for your interest in contributing! We welcome bug reports, feature suggestions, and code contributions from the UEFN community.

Reporting Issues

Found a bug or have a feature idea? Click "New Issue" and select a template:

  • 🐛 Bug Report - Issues with tools
  • ✨ Feature Request - New ideas or enhancements
  • ❓ Question - Get help

Contributing Code

  1. Fork the repository
  2. Create a branch: git checkout -b feature/your-feature
  3. Make your changes
    • Start new tools from the ToolTemplate/ folder
    • Follow existing code patterns
    • Test against a real UEFN project
  4. Commit: git commit -m "Add: your feature"
  5. Push: git push origin feature/your-feature
  6. Open a Pull Request

Code Standards

Architecture:

  • One tool per folder, each with its own README (start from ToolTemplate/)
  • Keep tools self-contained — declare dependencies in the tool's requirements.txt
  • Follow DRY and SOLID principles

Style Guide: Follow PEP 8, the official Python style guide

Key Conventions:

  • Classes: PascalCase
  • Variables/Functions: snake_case
  • Indentation: 4 spaces
  • Type hints and docstrings encouraged
  • Keep it readable and well-commented

Documentation:

  • Add inline comments for complex logic
  • Create a README for new tools (follow existing format)
  • Update docs if behavior changes

Community

Get Help:

Contact:

  • Discord DM: PineFruit, LastMadeUEFN
  • Epic: PineFruitDev, LastMadeMe
  • Twitter: @PineFruitDev, @LastMadeUefn

Thanks for contributing! 🎉 Your contributions help the UEFN community build better experiences.

License: Apache 2.0 with Commons Clause
Last Updated: August 2026