github
/
flarum
mirror of https://github.com/flarum/flarum
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README and contributing instructions

Browse Source
pull/9/head
Toby Zerner 9 years ago
parent e7092b841c
commit f5f0a1fd42
2 changed files with 21 additions and 95 deletions
Show Stats Download Patch File Download Diff File

64
CONTRIBUTING.md
Unescape View File

@ -1,68 +1,6 @@
# Contributing to Flarum # Contributing to Flarum
Thanks for your interest in 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.
## Stuff You Can Do
- **Report bugs.** If you find a bug, we'd like to know about it. Work out which GitHub repository the bug report belongs to (i.e. [an extension repository](http://github.com/flarum) vs. [the core repository](http://github.com/flarum)) and then give us as much information as you can. Thanks!
- **Give us feedback.** We want to know where Flarum falls short so that we can make it better. Tell us what you think on the [Development Forum](http://discuss.flarum.org) or in [Gitter](http://gitter.im/flarum/flarum).
- **Contribute code.** Take a look at the [issue list](http://github.com/flarum/core/issues) and see if there's anything you can help out with. See below for instructions on submitting a Pull Request.
- **Spread the word.** Tell the world about Flarum!
## Pull Requests
1. Review the [Contributor License Agreement](#contributor-license-agreement).
2. Create a new branch.
```sh
git checkout -b new-flarum-branch
```
> Please implement only one feature/bugfix per branch to keep pull requests clean and focused.
3. Code.
- Follow the coding style: [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md).
- Include tests and make sure they pass (subject to [#3](https://github.com/flarum/core/issues/3) and [#4](https://github.com/flarum/core/issues/4)).
4. Commit.
- Commit messages are **required**.
- They should include a short description of the changes on the first line, then a blank line, then more details if necessary.
5. Clean up. Squash together minor commits.
```sh
git rebase -i
```
6. Update your branch so that it is based on top of the latest code from the Flarum repository.
```sh
git fetch origin
git rebase origin/master
```
7. Fork your repository on GitHub and push to it.
```sh
git remote add mine git@github.com:<your user name>/flarum.git
git push mine new-flarum-branch
```
8. Submit a pull request.
- Go to the Flarum repository you just pushed to (e.g. https://github.com/your-user-name/flarum).
- Click "Pull Request".
- Write your branch name in the branch field.
- Click "Update Commit Range".
- Ensure that the correct commits and files changes are included.
- Fill in a descriptive title and other details about your pull request.
- Click "Send pull request".
10. Respond to feedback.
- We may suggest changes to your code. Maintaining a high standard of code quality is important for the longevity of this project — use it as an opportunity to improve your own skills and learn something new!
## Contributor License Agreement ## Contributor License Agreement

52
readme.md
Unescape View File

@ -1,48 +1,36 @@
# Flarum ![Flarum](http://flarum.org/img/logo.png)
**Delightfully simple forums.** [Flarum](http://flarum.org) is the next-generation forum software that makes online discussion fun again. **[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.
[Live Demo](http://demo.flarum.org) - [Features](http://flarum.org/features) -
[Development Forum](http://discuss.flarum.org) - [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) - [Twitter](http://twitter.com/flarum) -
[Contact](mailto:toby@flarum.org) - [Contact](mailto:toby@flarum.org) -
[Donate](http://flarum.org/donate) [Donate](http://flarum.org/donate)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/flarum/flarum) ![screenshot](http://127.0.0.1:4000/img/screenshot.png)
## Goals ## Goals
- **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 highly performant JavaScript framework with a tiny footprint. Flarum is the combined successor of [esoTalk](http://esotalk.org) and [FluxBB](http://fluxbb.org). It aims to be:
- **Beautiful and responsive.** This is forum software for humans. Flarum is carefully designed to be consistent and intuitive across platforms, out-of-the-box. It's backed by LESS, so themeing is a cinch.
- **Powerful and extensible.** Customize, extend, and integrate Flarum to suit your community. Flarum's architecture is amazingly flexible, prioritizing comprehensive APIs and great documentation.
- **Free and open.** Flarum is released under the [MIT license](https://github.com/flarum/flarum/blob/master/LICENSE.txt).
## Installation - **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.
**Flarum is currently in development and will be ready to use later this year.** ([Roadmap](http://tobyzerner.com/flarum/)) If you want to give the development version a spin or are interested in contributing, for now you can install Flarum's Vagrant image. An easier installation process will become a priority once Flarum is more stable. - **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).
1. Install [Vagrant](https://www.vagrantup.com) and [VirtualBox](https://www.virtualbox.org).
2. Clone this repository and set up the Vagrant box:
```sh
git clone --recursive https://github.com/flarum/flarum.git
cd flarum
vagrant up
```
3. Add an entry to your /etc/hosts file: ## Installation
```192.168.29.29 flarum.dev```
4. Visit flarum.dev in a browser.
## Contributing > **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.
Interested in contributing to Flarum? Read the [Contribution Guide](https://github.com/flarum/flarum/blob/master/CONTRIBUTING.md)! 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.x**.
Bug reports should go in [flarum/core](https://github.com/flarum/core/issues) or the [relevant extension repository](https://github.com/flarum). 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)!
### Core Team ## Core Team
- Toby Zerner ([esoTalk](http://esotalk.org), [@tobscure](http://twitter.com/tobscure)) - Toby Zerner ([GitHub](http://github.com/tobscure), [Twitter](http://twitter.com/tobscure))
- Franz Liedke ([FluxBB](http://fluxbb.org), [@franzliedke](http://twitter.com/franzliedke)) - Franz Liedke ([GitHub](http://github.com/franzliedke), [Twitter](http://twitter.com/franzliedke))

Write Preview
Loading…
Cancel
Save