We love pull requests from everyone. By participating in this project, you agree to play nice with others.
Fork the repo.
Install the dependencies:
npm install
Start the development server:
npm run serve
In another terminal, start the server:
npm run dev:node
Make changes.
Push to your fork and submit a pull request.
At this point you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Follow our style guide.
- Write a good commit message.
We have ESLint to check for style in the JavaScript and .vue files. Before you commit, please run a check and auto-fix before submitting a pull-request.
We use AirBnB's JavaScript guide to keep the codebase all in one cohesive format. Having an editor like Microsoft's VS Code will help check for ESLint mistakes as you write code. It is highly recommended.
We also use stylelint to lint the Sass code inside the .vue components, so please make sure to check the Git log for any Git failures.
When you develop locally, a test account is pre-loaded in the game so you do not need to set up the Laravel mumbo-jumbo and database and get off to a quicker start.
Of course, this comes with limitations like no saving a player's save file and only you can be logged in because we are mocking the player object.
You can easily download the website repo and make authentic connections to your local database. But the default option is local players are loaded.
We are in the process of adding these tools to help make the process of contributing and in general easier in the future.
- Sass Style checking (CSS)
- Commit checks. Check for style issues before commiting.
- Unit tests within Vue components