README

This the development repository for Simple Machines Forum. The software is licensed under BSD 3-clause license.

Contributions to documentation are licensed under CC-by-SA 3. Third party libraries or sets of images are under their own licenses.

Notes:

Feel free to fork this repository and make your desired changes.

Please see the Developer's Certificate of Origin in the repository: by signing off your contributions, you acknowledge that you can and do license your submissions under the license of the project.

Branches organization:

release-3.0 - is the branch where updates for version 3.0 are applied
release-2.1 - is the branch where updates for version 2.1 are applied

Setup

Using official releases provided by our downloads website requires no additional setup. A helpful guide is provided on our wiki.

If you are attempting to download from the source code provided on our github, you will need to run composer.

Install Composer v2 or higher (https://getcomposer.org)
Install the dependencies with composer as below (Developers read on)
```
composer install
```
If you are intending to do development, you will want to install the developer dependencies, you can append -dev to the command like so
```
composer install -dev
```
When updating (git pull), you should update the composer and may run into issues if not done so. Developers should add -dev to the command
```
composer update
```

How to contribute:

fork the repository. If you are not used to Github, please check out fork a repository.
branch your repository, to commit the desired changes.
sign-off your commits, to acknowledge your submission under the license of the project.
- It is enough to include in your commit comment "Signed-off by: " followed by your name and email address (for example: Signed-off-by: Your Name <youremail@example.com>)
- an easy way to do so is to define an alias for the git commit command, which includes -s switch (reference: How to create Git aliases)
send a pull request to us.
Do not modify the /vendor directory, rather update the appropriate dependency in composer.json, run composer update, then commit both composer.json and composer.lock files.

How to submit a pull request:

If you want to send a bug fix for version 3.0, send it to the branch release-3.0

Security matters:

Lastly, if you have a security issue you would like to notify us about regarding SMF for any version - please file a security report on our website: https://www.simplemachines.org/about/smf/security.php

For further information regarding our security policy, see SECURITY.md

simplemachines / smf

Maintainers

Details