Skip to content

blast007/bzion

 
 

Repository files navigation

BZiON Build Status Scrutinizer Code Quality Code Coverage

BZiON is a modern league management system (LMS) written for BZFlag leagues to manage players, teams, matches, and tournaments.

Contributors

Developers

These individuals have made multiple significant contributions to the project on a sustained basis. They become actively involved on improving and adding new features to the project.

Thanks to

These individuals have assisted significantly with guiding the project in its current direction and have contributed several suggestions to continuously improve the project.

Installation

The installation process is documented on the BZiON wiki and the requirements for installation are documented as well. If you're having issues during your installation, common issues are also documented on the wiki as well.

Do note that BZiON has not been thoroughly tested in production environments. As such, you are recommended to take regular backups of your database.

A demo BZiON installation can be found at demo.leaguesunited.org with a recent version of the master branch and sample data.

Contributing

This is an open source project and everyone is welcome to hack on the project. Don't see a feature you want? Write it and submit a pull request! Can't write code? Request it as a feature!

Bugs and Issues

If you're not comfortable with hacking on BZiON or you're not a coder, we are always looking for assistance in finding bugs and weird issues. As developers, we only imagine our code to be used the way it's intended but that's never the case! If you found a way to break our code, please let us know!

Documentation

BZiON uses a lot of Symfony2 components internally, so the respective documentation can be found on the Symfony2 website. Aside from the components, the source code for the project has been thoroughly documented and the phpDoc can be found on alezakos' website.

Most modern IDEs will easily be able to read BZiON's phpDoc and provide you with the respective documentation on how certain classes or functions are used.

Pull Requests

Wrote a feature you'd like to see available in BZiON or fixed a bug? Send us a pull request and we'll gladly take a look.

Before you send us a pull request, here are a few things we look for:

  • Your code is neatly written and follows the coding style of the project as closely as possible
  • Your pull request is actually functional and works as intended
  • Your pull request does not break functionality of the master branch nor the unit tests
  • Your new feature will benefit the league community or will improve the experience for league members
  • Your pull request is not adding TODOs in the code, giving the developers more things to do
  • If submitting a bug fix, specify what the bug is, when it occurs, and how your pull request has fixed the bug

To increase the probability of your pull request being accepted, ensure you consider the things we look for when evaluating pull requests. We're not actually mean, we absolutely love pull requests! We simply would like the pull request process to go smoothly and quickly.

Feature Requests

While BZiON is still in development, there are a lot of features that are planned but aren't thoroughly documented or specified anywhere and a lot of functionality still needs to be written so feature requests are not a high priority for developers.

While feature requests may not be a high priority, we would still love to hear your ideas and look forward to implementing the best ideas so submit an issue and label it as "enhancement" and we'll be able to discuss the feature thoroughly.

Questions?

All of the development discussions for this project occur on #sujevo on irc.freenode.net, feel free to stop by and talk with a developer! We love the company.

License

GNU General Public License 3.0

About

A League Management System (LMS) designed for BZFlag leagues and tournaments.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 70.9%
  • HTML 13.4%
  • CSS 10.5%
  • JavaScript 3.3%
  • Gherkin 1.1%
  • Shell 0.5%
  • Other 0.3%