Contributions are welcome and will be fully credited. There are various ways to contribute:
- Report bugs or request new features/improvements via the Issues page.
- Start a discussion around new ideas or suggestions on the Discussions page.
- Contribute code via Pull Requests on Github.
Before submitting a new issue, please check the issues and pull requests to avoid duplicates.
If you have an idea or suggestion, feel free to start a discussion on the Discussions page. This is a great way to get feedback and discuss new ideas before submitting a pull request.
If you would like to contribute via pull requests, a good way to get started is to filter the issues list by the good first issues label. This label is used for issues that are easy to fix and a good starting point for new contributors.
Refer to the Installation section in the main README.md for how to get your local development environment setup.
When submitting a pull request, please make sure to follow these guidelines:
The easiest way to check if your contributed code adheres to the conventions is to run the Laravel Pint script which is auto installed via Composer:
$ ./vendor/bin/pint --test --preset psr12
Tip: it's possible to let Laravel Pint attempt to fix the code for you by running it without the --test flag:
$ ./vendor/bin/pint --preset psr12
Make sure that your code passes the PHPStan static code analysis. You can run PHPStan locally using the following command:
$ ./vendor/bin/phpstan analyse --memory-limit=384M
Your PR should include feature or unittests where possible to cover the changes you made. OGameX uses the default Laravel testing framework which covers feature and unittests by default. To run the tests locally, you can use the following command:
$ php artisan test
If you are working on a feature that might introduce race conditions, please include tests that cover these scenarios. OGameX already contains some custom tests that can be run via php artisan commands. These tests support running multiple requests in parallel and in multiple iterations in order to simulate conditions that could cause race conditions.
These tests are located in the console/Commands/Tests directory and can be run using the following command:
$ php artisan test:race-condition-unitqueue
$ php artisan test:race-condition-game-missionOGameX uses Laravel Mix to compile the CSS and JS assets. Before submitting a PR, make sure to run the following command to compile the assets. This command can be run in watch mode to automatically recompile the assets when changes are made which is useful during development.
$ npm run dev watch