You have been redirected from an outdated version of the article. Below is the content available on this topic. To view the old article click here.

Contribute

The main areas you can contribute to the Structr project are:

  • Documentation
  • Examples / Demos
  • Code

Documentation

Please open a ticket in our support system to submit change requests or questions related to documentation.

Examples / Demos

Please proceed to the Showcase Page on structr.org!

Code

We accept code contributions to Structr in the form of GitHub Pull Requests. You can use the below checklist to make sure that we can easily merge your request.

Did you sign the CLA? The Contributor License Agreement (CLA) must be signed before we can accept contributions.
Did you combine all changes into a single commit? To be able to review a Pull Request, please combine all changes to a single commit.
Did you rebase against the latest master? The PR has to be based on the master branch.
Did all the tests succeed? All current tests, including tests for the functionality you added, have to pass.

If you can check all the boxes above, you’re ready to send the pull request!

Contribution Guidelines

For technical standards, please read this article: Contributing to Open Source on GitHub

The first and most important step for you to do is to agree to our Contributor License Agreement, otherwise we can not accept your contribution. This is neccessary for us to save your contributions from third-party claims and to get your permission to bundle it with Structr.

You can find the Contributor License Agreement (CLA) at https://structr.org/cla.

How to Agree

You can either send an e-mail to team@structr.com stating that you agree to the CLA at https://structr.org/cla,
include the agreement in your pull request at GitHub, or state that you agree in a separate GitHub comment.Writing Documentation

If you write documentation, please follow these guidelines: A beginners guide to writing documentation

Clone the Structr repository and issue pull requests for the markdown documents.

The following users have contributed to Structr so far (ordered by number of their commits):

Axel Morgner
Christian Morgner
Kai Schwaiger
Alexander Thiele
Ilias Lazardis
Bastian Knerr
Joerg Bellmann
Christian Kramp
David Shepard
Holger Loh
Marcel Romagnuolo
Dennis Laske
Wayne Riesterer
Shawn Anderson
Gerd Aschemann
Eric Schleicher
Brian Bagdasarian

Search results for "Contribute"

We could not find anything matching "Contribute" in our documentation. Please rephrase your search.

You can also ask your questions in the Structr Google Group or create a free account in the Structr Support Portal.
Click here to send feedback to the Structr team.