5. The Contribution Guide

Note

This section is based on the great Symfony documentation.
The following is a set of guidelines for contributing to Blast on GitHub.

5.1. How to install Blast to contribute?

Before you start contributing you need to have your own local environment for editing things.

To install Blast main application from our main repository and contribute, run the following command:

$ composer create-project -s dev blast-project/blast

5.2. Reporting bugs and suggesting enhancements

Before creating issues, please check this list as you might find out that you don’t need to create one. When you are creating a new issue, please include as many details as possible to help maintainers reproduce the problem or understand your suggestion.

5.3. Submitting changes

Like most projects, we propose a standard GitHub Flow for contributions:

  1. Fork
  2. Create a topic branch
  3. Add commits
  4. Create a Pull Request
  5. Discuss and review your code
  6. Merge

If you want to submit changes, please send a GitHub Pull Request with a clear list of what you’ve done (read more about pull requests).

Please make sure all of your commits are atomic (one feature per commit) and always write a clear log message for your commits to help maintainers understand and review your submission.