|
| 1 | +# How to Contribute to InspireCMS |
| 2 | + |
| 3 | +:sparkles: Before we get started, thank you for taking the time to contribute! :sparkles: |
| 4 | + |
| 5 | +This is a guideline for contributing to InspireCMS, its documentation, and addons. All of these wonderful things are hosted here in the [InspireCMS organization](https://github.com/solutionforest/inspirecms-core) on GitHub. We welcome your feedback, proposed changes, and updates to these guidelines. We will always welcome thoughtful issues and consider pull requests. |
| 6 | + |
| 7 | +#### Table of Contents |
| 8 | + |
| 9 | +- [What You Should Know Before Contributing](#what-you-should-know-before-contributing) |
| 10 | +- [InspireCMS isn’t FOSS](#InspireCMS-isnt-foss) |
| 11 | +- [How to Get Support](#how-to-get-support) |
| 12 | +- [How You Can Contribute](#how-you-can-contribute) |
| 13 | +- [Which Repo?](#which-repo) |
| 14 | +- [Bug Reports](#bug-reports) |
| 15 | +- [Feature Requests](#feature-requests) |
| 16 | +- [Security Disclosures](#security-disclosures) |
| 17 | +- [Core Enhancements](#core-enhancements) |
| 18 | +- [Documentation Edits](#documentation-edits) |
| 19 | +- [Pull Requests](#pull-requests) |
| 20 | + |
| 21 | +## What You Should Know Before Contributing |
| 22 | + |
| 23 | +### InspireCMS isn’t FOSS |
| 24 | + |
| 25 | +While InspireCMS's source code is open source, publicly available, and can be [used for free](https://inspirecms.net/#pricing) in many cases, it is proprietary. Everything in this repo, including any community-contributed code, is the property of Solution Forest Limited. For that reason there are a few limitations on how you can use the code: |
| 26 | + |
| 27 | +- You cannot alter anything related to licensing, updating, version or edition checking, purchasing, first party notifications or banners, or anything else that attempts to circumvent paying for features that are designated as InspireCMS Pro features. We want to stay in business so we can better support _you_ and the community. |
| 28 | +- You can’t publicly maintain a long-term fork of InspireCMS. |
| 29 | + |
| 30 | +### How to Get Support |
| 31 | + |
| 32 | +If you're looking for official developer support (and you have an active license), please email us halo@inspirecms.net. We will always do our best to reply in a timely manner. **Github issues are intended for reporting bugs.** |
| 33 | + |
| 34 | +## How You Can Contribute |
| 35 | + |
| 36 | +### Which Repo? |
| 37 | + |
| 38 | +InspireCMS is broken out into a few Github repositories. Here's a quick summary of each. |
| 39 | + |
| 40 | +- [`Inspirecms-core`](https://github.com/solutionforest/Inspirecms-core) 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. |
| 41 | + |
| 42 | +### Bug Reports |
| 43 | + |
| 44 | +First things first. If the bug is security related refer to our [security disclosures](#security-disclosures) procedures instead of opening an issue. |
| 45 | + |
| 46 | +Next, please search through the [open issues](https://github.com/solutionforest/Inspirecms-core/issues) to see if it has already been opened. |
| 47 | + |
| 48 | +If you _do_ find a similar issue, upvote it by adding a :thumbsup: [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Only leave a comment if you have relevant information to add. |
| 49 | + |
| 50 | +If no one has filed the issue yet, feel free to [submit a new one](https://github.com/solutionforest/Inspirecms-core/issues/new?template=bug.yml). 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. |
| 51 | + |
| 52 | +### Feature Requests |
| 53 | + |
| 54 | +TBC |
| 55 | + |
| 56 | +### Security Disclosures |
| 57 | + |
| 58 | +If you discover a security vulnerability, please review our [Security Policy](https://github.com/solutionforest/Inspirecms-core/security/policy). We will review and respond privately via email. |
| 59 | + |
| 60 | +### Documentation Edits |
| 61 | + |
| 62 | +InspireCMS's documentation lives in the [https://github.com/solutionforest/Inspirecms-core/tree/main/docs](https://github.com/solutionforest/Inspirecms-core/tree/main/docs) repository. Improvements or corrections to them can be submitted as a pull request. |
| 63 | + |
| 64 | +### Core Enhancements |
| 65 | + |
| 66 | +If you would like to work on a new core feature or improvement, first create a [Github issue](https://github.com/solutionforest/Inspirecms-core/issues) for it if there’s not one already. While we appreciate community contributions, we do remain selective about what features make it into InspireCMS itself, so don’t take it the wrong way if we recommend that you pursue the idea as an addon instead. |
| 67 | + |
| 68 | +### Pull Requests |
| 69 | + |
| 70 | +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. |
| 71 | + |
| 72 | + |
| 73 | + |
0 commit comments