Skip to content
Permalink
master
Switch branches/tags

cms/CONTRIBUTING.md

Go to file
@jackmcdade
jackmcdade Just Statamic (#5404)
Latest commit 23c2f46 Mar 4, 2022 History
5 contributors

Users who have contributed to this file

How to Contribute to Statamic Table of Contents What You Should Know Before Contributing Statamic isn’t FOSS How to Get Support How You Can Contribute Which Repo? Bug Reports Feature Requests Security Disclosures Documentation Edits Core Enhancements Compiled Assets Control Panel Translations Pull Requests
90 lines (54 sloc) 5.78 KB
Raw Blame

How to Contribute to Statamic

✨ Before we get started, thank you for taking the time to contribute! ✨

This is a guideline for contributing to Statamic, its documentation, and addons. All of these wonderful things are hosted here in the Statamic organization on GitHub. We welcome your feedback, proposed changes, and updates to these guidelines. We will always welcome thoughtful issues and consider pull requests.

Table of Contents

What You Should Know Before Contributing

Statamic isn’t FOSS

Statamic is not Free Open Source Software. It is proprietary. Everything in this and our other repos on Github — including community-contributed code — is the property of Wilderborn. For that reason there are a few limitations on how you can use the code:

  • You cannot redistribute or use Statamic as a dependency in another project — open source or otherwise — without prior permission or licensing.
  • You cannot alter anything related to licensing, updating, version/edition checking, or anything else that would circumvent our business model. We want to stay in business so we can support you better.
  • You can’t publicly maintain a long-term fork of Statamic.

How to Get Support

If you're looking for official developer support (and you own a license), please go to statamic.com/support and we will always do our best to reply in a timely manner. Github issues are intended for reporting bugs and resolving issues.

You can chat and collaborate with other developers in the community — Discord and the forum are the best places to go. You will find many helpful folks who may be willing to help.

How You Can Contribute

Which Repo?

Statamic is broken out into a few Github repositories. Here's a quick summary of each.

  • statamic/cms is the core package. It doesn't run by itself but is instead a dependency consumed by Laravel apps. 99% of the work goes on here.
  • statamic/statamic is the starter Laravel app used to build a new site.
  • statamic/docs is the Statamic documentation site that is curently running on statamic.dev.

Bug Reports

First things first. If the bug is security related refer to our security disclosures procedures instead of opening an issue.

Next, please search through the open issues to see if it has already been opened.

If you do find a similar issue, upvote it by adding a 👍 reaction. Only leave a comment if you have relevant information to add.

If no one has filed the issue yet, feel free to submit a new one. Please include a clear description of the issue, follow along with the issue template, and provide and as much relevant information as possible. Code examples demonstrating the issue are the best way to ensure a timely solution to the issue.

Feature Requests

Feature requests should be created in the statamic/ideas repository.

Security Disclosures

If you discover a security vulnerability, please review our Security Policy, then report the issue directly to us from statamic.com/support. We will review and respond privately via email.

Documentation Edits

Statamic's documentation lives in the https://github.com/statamic/docs repository. Improvements or corrections to them can be submitted as a pull request.

Core Enhancements

If you would like to work on a new core feature or improvement, first create a Github issue for it if there’s not one already. While we appreciate community contributions, we do remain selective about what features make it into Statamic itself, so don’t take it the wrong way if we recommend that you pursue the idea as an addon instead.

Compiled Assets

If you are submitting a change that will affect a compiled file, such as most of the files in resources/sass or resources/js, do not commit the compiled files. Due to their large size, they cannot realistically be reviewed by our team. This could be exploited as a way to inject malicious code into Statamic. In order to defensively prevent this, all compiled files will be generated and committed by the core Statamic team.

Control Panel Translations

We welcome new translations and updates! Please follow these instructions on how to contribute to Statamic's translation files.

Pull Requests

Pull requests should clearly describe the problem and solution. Include the relevant issue number if there is one. If the pull request fixes a bug, it should include a new test case that demonstrates the issue, if possible.


Thank you! Stay rad. If you're not already rad, tell us and we will make it so.

✨