Skip to main content

Contributing to Rayforge

Help improve Rayforge: report bugs, suggest features, submit code, refine docs, or support the project financially.

Support on PatreonReport a BugStart Contributing
GitHub

Community & Support

Report issuesGitHub IssuesBrowse sourceGitHub repositoryBecome a SponsorHelp us Improve

Quick Actions

Report a Bug

Open an issue with steps to reproduce and what you expected.

Suggest a Feature

Share a use case and what success looks like for you.

Submit Code

Follow the developer guide and send a pull request.

Improve Documentation

Fix typos, add examples, and make the docs easier to follow.

Ways to Contribute

We welcome contributions of all kinds. Every bug report, PR, and documentation fix makes Rayforge better for everyone.

Report Bugs

  1. Check existing issues to avoid duplicates.
  2. Create a new issue with a clear description, steps to reproduce, expected vs. actual behavior, system info, and screenshots if applicable.

Suggest Features

  1. Review existing feature requests.
  2. Open a feature request describing the idea, use case, benefits, and (optionally) a possible approach.

Submit Code

For detailed information on submitting code contributions, follow the Developer Documentation – Getting Started guide.

Improve Documentation

  • Fix typos or unclear explanations
  • Add examples and screenshots
  • Improve organization
  • Translate to other languages

Use the “edit this page” button on any documentation page and submit PRs the same way as code contributions.

About This Documentation

This documentation is designed for end-users of Rayforge. For developer docs, start here: Developer Documentation.