Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.37 KB

File metadata and controls

43 lines (32 loc) · 1.37 KB

🎃 Contributing to Sleepy Hollows 🎃

Thanks for stopping by, we're glad you're here,
To help our mod grow with some Halloween cheer!
PRs are welcome, so don’t be shy,
Just keep the code clean—no dead code left to lie.

How You Can Help

  • Pull Requests (PRs): Bring them our way!
    Check your code's style before hitting "OK."
  • Feature Requests? Share what you think!
    Open a suggestion, don't let ideas shrink!
  • Found a bug? Don’t let it hide,
    Write a clear report, and we’ll take it in stride.

Guidelines

  • Clean Code is our golden rule,
    Dead code is a ghost—don’t let it be cruel.
  • Commit Messages should be crisp and clear,
    So our history stays easy to steer.
    Though not a must, it's wise to see,
    Following Conventional Commits is key

Code Style

  • Follow the style that’s already here,
    So all of our code stays cozy and clear.
  • Ensure your code builds without error or fright,
    Before you submit, make sure it’s all right.

Testing

  • Test your changes, make sure they're tight,
    So in Sleepy Hollows, they work just right.
  • Add tests if needed or explain what you’ve done,
    So others can see how your magic is spun.

License

By contributing here, you agree to align,
With the project’s license—keep everything fine.