|
| 1 | +# Contributing to LittleLink Custom |
| 2 | + |
| 3 | +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: |
| 4 | + |
| 5 | +- Reporting a bug |
| 6 | +- Discussing the current state of the code |
| 7 | +- Submitting a fix |
| 8 | +- Proposing new features |
| 9 | +- Becoming a maintainer |
| 10 | + |
| 11 | +## We use Discord to communicate |
| 12 | + |
| 13 | +This is the fastest way to reach us. Feel free to contact the team for any questions you have. |
| 14 | +[Join here]( https://discord.gg/CFZm2qeCVM ) |
| 15 | + |
| 16 | +## We Develop with Github |
| 17 | + |
| 18 | +We use github to host code, to track issues and feature requests, as well as accept pull requests. |
| 19 | + |
| 20 | +## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests |
| 21 | + |
| 22 | +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: |
| 23 | + |
| 24 | +1. Fork the repo and create your branch from `master`. |
| 25 | +2. Clone your repository to your local machine. |
| 26 | +3. Open a terminal window in that folder. |
| 27 | +4. Run these commands: |
| 28 | +``` |
| 29 | +composer update -vvv |
| 30 | +
|
| 31 | +php artisan migrate |
| 32 | +php artisan db:seed |
| 33 | +php artisan db:seed --class="AdminSeeder" |
| 34 | +php artisan db:seed --class="PageSeeder" |
| 35 | +php artisan db:seed --class="ButtonSeeder" |
| 36 | +``` |
| 37 | +5. Move the folder into a local web server (make sure you double-check the [requirements](https://littlelink-custom.com/docs/d/installation-requirements/)). |
| 38 | +6. Now edit any files you want to change. |
| 39 | +7. Commit your changes to your forked repository. |
| 40 | +2. Issue that pull request! |
| 41 | + |
| 42 | +## Any contributions you make will be under the GPL-3.0 Software License |
| 43 | + |
| 44 | +In short, when you submit code changes, your submissions are understood to be under the same [GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/) that covers the project. Feel free to contact the maintainers if that's a concern. |
| 45 | + |
| 46 | +## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues) |
| 47 | + |
| 48 | +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! |
| 49 | + |
| 50 | +## Write bug reports with detail, background, and sample code |
| 51 | + |
| 52 | +**Great Bug Reports** tend to have: |
| 53 | + |
| 54 | +- A quick summary and/or background |
| 55 | +- Steps to reproduce |
| 56 | + - Be specific! |
| 57 | + - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing |
| 58 | +- What you expected would happen |
| 59 | +- What actually happens |
| 60 | +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) |
| 61 | + |
| 62 | +People *love* thorough bug reports. I'm not even kidding. |
| 63 | + |
| 64 | + |
| 65 | +## License |
| 66 | + |
| 67 | +By contributing, you agree that your contributions will be licensed under its GPL-3.0 License. |
| 68 | + |
0 commit comments