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!
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.
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.
If you intend on writing a large feature, create an issue first and discuss your vision with us. We would hate for you to waste your time on writing something we don't think would be best for the project.
Wrote a neat little 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
- 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 love pull requests. We simply would like the pull request process to go smoothly and quickly, all the while keeping things organized.
We would love to hear your ideas and look forward to implementing the best of them, so submit an issue and we'll be able to discuss the feature further.
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.
These are notes targeted towards developers or contributors targeting more core related aspects of BZiON.
The minimum PHP version that BZiON currently supports is 5.6, therefore when running composer update it is necessary to run it with PHP 5.6. Should BZiON's minimum requirement change, updates to the lock file must be run with the lowest minimum version that BZiON targets.
Before tagging a new release, here are few things that need to be done. Eventually this'll become a single command, but for now, go through the checklist.
-
Check if Rank sprites have been modified. If so, rebuild them following the instructions at /assets/ranks/README.md.
-
Compile Sass and JavaScript assets. These files should not be committed during development since they'll change often. Developers are expected to always be able to compile the files themselves during development.
node_modules/.bin/gulp dist node_modules/.bin/encore production -
Commit the modified files: CSS, JS, and the ranks sprite.
This project follows a Git Flow-like scheme for branch management. Any branches where new features are being developed should be prepended with feature/; however that's the only practice that has been adopted.
Due to extremely limited resources, only the latest minor version of BZiON is maintained. For example, once 0.11.0 is released, all previous releases will be reach EOL.
| Branch | Version | Status | Description |
|---|---|---|---|
| master | 0.11.x | Dev | This branch contains the current development version (0.11.x) of BZiON and should always be kept stable; features in development belong in their own feature branches. |
| 0.10 | 0.10.x | Stable | This branch contains the development version of the 0.10.x pipeline. This branch will reach EOL once 0.11.0 has been released. |
| 0.9 | 0.9.x | EOL | This branch contains the development version of the 0.9.x pipeline. |
| 0.1 | 0.1.x | EOL | This branch contains legacy code for a very early attempt of BZiON. This branch is only around for historical purposes. |