Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (61 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

92 lines (61 loc) · 2.16 KB

Contributing to Structr

Thank you for your interest in contributing to Structr!

Structr is developed openly and contributions from the community are welcome. This document outlines how to ask questions, report issues, and contribute code or documentation.

First: Where to Ask Questions

Before submitting issues or pull requests, please use the Structr Forum for questions, ideas, and general discussions:

👉 https://structr.org/forum

The forum is the preferred place for:

  • Usage questions
  • Architecture and design discussions
  • Feature ideas
  • Conceptual or exploratory topics
  • Clarifying whether something is a bug or expected behavior

This helps keep the GitHub issue tracker focused and actionable.

Reporting Issues (GitHub)

Please use the GitHub issue tracker only for confirmed bug reports.

Before opening an issue:

  • Check the forum to see whether the topic has already been discussed
  • Ensure the issue describes a reproducible bug

When reporting a bug, include:

  • Structr version
  • Deployment setup
  • Steps to reproduce
  • Expected and actual behavior
  • Relevant logs or error messages (if available)

Code Contributions

Once a topic or solution has been discussed (e.g. in the forum), code contributions are welcome.

To contribute code:

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Ensure code builds and tests pass
  5. Submit a pull request

Pull requests should:

  • Focus on a single change
  • Include a clear description
  • Reference related forum discussions or GitHub issues if applicable

Coding Style & Quality

  • Follow existing coding conventions
  • Prefer clarity and readability
  • Add documentation where appropriate
  • Avoid breaking backward compatibility unless discussed beforehand

Licensing of Contributions

By submitting a contribution, you agree that your contribution may be licensed under the same terms as the project:

  • AGPL-3.0-or-later
  • GPL-3.0-or-later
  • and/or a commercial license offered by Structr GmbH

Community Conduct

Please be respectful and constructive in all interactions. See CODE_OF_CONDUCT.md for details.

Thank you for contributing to Structr!