mirror of https://github.com/flarum/flarum
Update docs for beta 3
Toby Zerner
parent
8b6697dea9
commit
fad38c0bbd
|
|
@ -1,6 +1,60 @@
|
|||
# Contributing to Flarum
|
||||
|
||||
Thanks for your interest in contributing to Flarum! Please read the [Contributing docs](http://flarum.org/docs/contributing) to learn how you can help.
|
||||
Howdy! We're really excited that you are interested in contributing to Flarum. Before submitting your contribution, please take a moment and read through the following guidelines.
|
||||
|
||||
## Reporting Bugs
|
||||
|
||||
- Before opening an issue, debug your problem by following [these instructions](http://flarum.org/docs/contributing). Only open an issue if you are confident it is a bug with Flarum, not with your own setup.
|
||||
|
||||
- All issues should be reported on the [flarum/core](https://github.com/flarum/core/issues) repository. Issues pertaining to a specific extension should include the extension name in their title, e.g. `[Tags] Issue title`.
|
||||
|
||||
- Try to search for your issue – it may have already been answered or even fixed in the development branch.
|
||||
|
||||
- Check if the issue is reproducible with the latest version of Flarum. If you are using a pre-release or development version, please indicate the specific version you are using.
|
||||
|
||||
- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear repro steps will not be triaged. If an issue labeled "needs verification" receives no further input from the issue author for more than 5 days, it will be closed.
|
||||
|
||||
### Security Vulnerabilities
|
||||
|
||||
If you discover a security vulnerability within Flarum, please send an email to [security@flarum.org](mailto:security@flarum.org).
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
- Read the [Contributor License Agreement](#contributor-license-agreement).
|
||||
|
||||
- Checkout a topic branch from `master` and merge back against `master`.
|
||||
|
||||
- Do NOT checkin the JavaScript `dist` files in commits.
|
||||
|
||||
- [Squash the commits](http://davidwalsh.name/squash-commits-git) if there are too many small ones.
|
||||
|
||||
- Follow the [code style](#code-style).
|
||||
|
||||
## Code Style
|
||||
|
||||
- PHP: [PSR-2 coding standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md), [PHPDoc](http://www.phpdoc.org/docs/latest/index.html)
|
||||
|
||||
- JavaScript: [Airbnb Style Guide](https://github.com/airbnb/javascript), [ESDoc](https://esdoc.org/tags.html)
|
||||
|
||||
- When in doubt, read the source code.
|
||||
|
||||
## Development Setup
|
||||
|
||||
[flarum/flarum](https://github.com/flarum/flarum) is a "skeleton" application which uses Composer to download [flarum/core](https://github.com/flarum/core) and a [bunch of extensions](https://github.com/flarum). In order to work on these, you will need to change their versions to `dev-master` in `composer.json` and install them from source:
|
||||
|
||||
```bash
|
||||
$ composer update --prefer-source
|
||||
```
|
||||
|
||||
Flarum's front-end code is written in ES6 and transpiled into JavaScript. The compiled JavaScript is only committed when we tag a release; during development you will need to do it yourself. To recompile the JavaScript you will need [Node.js](http://nodejs.org).
|
||||
|
||||
```bash
|
||||
$ npm install -g gulp
|
||||
$ cd vendor/flarum/core
|
||||
$ ./scripts/compile.sh
|
||||
```
|
||||
|
||||
Check out the [Roadmap](https://github.com/flarum/core/issues/74) for an overview of what needs to be done. See the [Good For New Contributors](https://github.com/flarum/core/labels/Good%20for%20New%20Contributors) label for a list of issues that should be relatively easy to get started with.
|
||||
|
||||
## Contributor License Agreement
|
||||
|
||||
|
|
|
|||
43
readme.md
43
readme.md
|
|
@ -1,36 +1,33 @@
|
|||
|
||||
|
||||
**[Flarum](http://flarum.org) is free, open-source forum software with a focus on simplicity.** You can use Flarum to easily set up a discussion forum for your website.
|
||||
**[Flarum](http://flarum.org) is free, open-source forum software** built with PHP and [Mithril.js](http://mithril.js.org). It is:
|
||||
|
||||
[Features](http://flarum.org/features) -
|
||||
[Download](http://flarum.org/download) -
|
||||
[Documentation](http://flarum.org/docs) -
|
||||
[Community](http://discuss.flarum.org) -
|
||||
[Gitter Chat](https://gitter.im/flarum/flarum) -
|
||||
[Twitter](http://twitter.com/flarum) -
|
||||
[Contact](mailto:toby@flarum.org) -
|
||||
[Donate](http://flarum.org/donate)
|
||||
* **Simple**, with a responsive UI that is optimized for touch devices
|
||||
* **Fast**, with a total JS payload size of ~130 KB gzipped
|
||||
* **Extensible**, so you can tailor it to your use-case
|
||||
|
||||
|
||||
|
||||
## Goals
|
||||
|
||||
Flarum is the combined successor of [esoTalk](http://esotalk.org) and [FluxBB](http://fluxbb.org). It aims to be:
|
||||
|
||||
- **Fast and simple.** No clutter, no bloat, no complex dependencies. Flarum is built with PHP so it's quick and easy to deploy. The interface is powered by Mithril, a performant JavaScript framework with a tiny footprint.
|
||||
- **Beautiful and responsive.** This is forum software for humans. Flarum is carefully designed to be consistent and intuitive across platforms, out-of-the-box.
|
||||
- **Powerful and extensible.** Customize, extend, and integrate Flarum to suit your community. Flarum's architecture is amazingly flexible, prioritizing comprehensive APIs and great [documentation](http://flarum.org/docs).
|
||||
- **Free and open.** Flarum is released under the [MIT license](https://github.com/flarum/flarum/blob/master/LICENSE).
|
||||
|
||||
## Installation
|
||||
|
||||
> **Flarum is currently in beta and should not be used in production.** It is being developed openly on GitHub. Check out the [Roadmap](http://flarum.org/roadmap) to follow along with our progress.
|
||||
|
||||
To give Flarum a spin, go to the [Download](http://flarum.org/download) page. You'll need a server with **PHP 5.5+** and **MySQL 5.5+**.
|
||||
You must have SSH access to a server with **PHP 5.5+** and **MySQL 5.5+**, and install [Composer](https://getcomposer.org).
|
||||
|
||||
If you want to hack on Flarum, you'll need to set up a development environment. Read how in the [Contributing docs](http://flarum.org/docs/contributing)!
|
||||
```
|
||||
composer create-project flarum/flarum
|
||||
```
|
||||
|
||||
## Core Team
|
||||
Read the [Installation Guide](http://flarum.org/docs/installation) for more information.
|
||||
|
||||
- Toby Zerner ([GitHub](http://github.com/tobscure), [Twitter](http://twitter.com/tobscure))
|
||||
- Franz Liedke ([GitHub](http://github.com/franzliedke), [Twitter](http://twitter.com/franzliedke))
|
||||
## Support
|
||||
|
||||
Refer to the [FAQ](http://flarum.org/docs/faq), [Documentation](http://flarum.org/docs), and ask questions on the [Community Forum](http://discuss.flarum.org) or [Gitter Chat](https://gitter.im/flarum/flarum).
|
||||
|
||||
## Contributing
|
||||
|
||||
Flarum is open-source and we would love your help building it! Please read the [Contributing Guide](https://github.com/flarum/flarum/blob/master/CONTRIBUTING.md) to learn how you can help.
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2015 Toby Zerner. Code released under the [MIT License](https://github.com/flarum/flarum/blob/master/LICENSE).
|
||||
|
|
|
|||
Loading…
Reference in New Issue