👍🎉 Thanks for taking the time to contribute! 🎉👍
First steps include creating your own repository of QuickInstall, and getting a copy of it onto your computer:
-
On GitHub, Fork your own copy of
phpbb/quickinstallto your account. -
Create a local clone of your fork:
$ git clone git://github.com/<my_github_name>/quickinstall.git
Assuming you have a local web development server up and running and know how to use a command line terminal application:
- From QI's root directory, run the following command to install QI's dependencies:
$ php composer.phar install
- Open QuickInstall in a browser on your local web server (e.g.,
https://localhost/quickinstall).
Optional: QuickInstall uses the Bootstrap framework which is compiled via NPM. To update or customise QuickInstall's Bootstrap files you must:
- Have Node JS installed.
- Run
$ npm installto install its node dependencies.- Edit the
scss/qi_bootstrap.scssfile to customise Bootstrap variables.- Run
$ npm run allto compile and deploy new Bootstrap CSS/JS files to QuickInstall.
- Create a new branch in your repository before doing any work. It should be based off the
developbranch:
$ git checkout -b myNewbranch origin/develop
- Do work on your branch, commit your changes and push it to your repository:
$ git commit -a -m "My new feature or bug fixes"
$ git push origin myNewbranch
-
Go to your repository on GitHub.com.
-
Click the Pull Request button.
Be prepared for:
- Constructive criticism of your code changes.
- phpBB team members, or the community at large may request changes to your code (repeat step 2 from here).
- That feeling when your Pull Request is accepted and merged. 😎