👍 🎉 😻 Thanks for your interest! 😻 🎉 👍
The following is a set of guidelines for contributing to MTG Arena Tool, hosted here on GitHub. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Note that MTG Arena Tool is an evolving project, so expect things to change over time as the team learns, listens, and refines how we work with the community.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
⭐ 🌟 Please join the discussion on our Discord #devs channel!
🌟 ⭐
This is easiest way to get started immediately, and hopefully another contributor can help answer questions about set up or current guidelines.
This section guides you through submitting a bug report for MTG Arena Tool. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that the problem has already been reported. If it does exist, add a 👍 to the issue to indicate this is also an issue for you, and add a comment to the existing issue if there is extra information you can contribute.
Bugs are tracked as GitHub issues.
Simply create an issue on the MTG Arena Tool issue tracker.
The information we are interested in includes:
- details about your environment - which build, which trackers are running, which operating system
- details about reproducing the issue - what steps to take, what happens, how often it happens, what you expect to happen instead
- other relevant information - log files, screenshots, etc
This section guides you through submitting an enhancement suggestion for MTG Arena Tool, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that the enhancement has already been suggested. If it has, add a 👍 to indicate your interest in it, or comment if there is additional information you would like to add.
Enhancement suggestions are tracked as GitHub issues.
Simply create an issue on the MTG Arena Tool issue tracker.
Some additional advice:
- Use a clear and descriptive title for the feature request
- Provide a step-by-step description of the suggested enhancement This additional context helps the maintainers understand the enhancement from your perspective
- Explain why this enhancement would be useful to MTG Arena Tool users
- Include screenshots and animated GIFs if relevant to help you demonstrate the steps or point out the part of MTG Arena Tool which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows
- List some other applications where this enhancement exists, if applicable
MTG Arena Tool is developed using Electron JS, To get started simply clone this repo and install:
git clone https://github.com/Manuel-777/MTG-Arena-Tool
cd MTG-Arena-Tool
npm install
npm run start:all
Once webpack builds, after the initial start:all command, you can make builds faster by invoking
the build process for the process you modified only;
npm run start:renderer
npm run start:background
npm run start:overlay
npm run start:updater
npm run start:main
If you modify shared code, it is recommended to use the start:all command again.
You can toggle developer tools for debugging using Shift+Alt+D, or use F12 to view the renderer process's tools if you run from source.
Use Shift+Alt+O to open the developer tools for the overlay process.
In the project directory, you can run:
Removes all cached local build state and reinstalls all dependencies from scratch.
This will most likely change your working tree because it requires removing and
re-creating package-lock.json.
Convenience script to remove node_modules.
Convenience script to remove package-lock.json.
Installs all required dependencies.
Automatically formats all source code to match project guidelines. We currently use
prettier and eslint to keep things looking tidy.
Runs all project tests. This includes unit tests run via jest and style guidelines
enforced by eslint and prettier.
Tests all source code against project eslint and prettier style guidelines.
See https://eslint.org/ See https://prettier.io/
Runs all project unit tests via jest.
Builds a packaged version of the project for potential distribution.
You can optionally install git hooks to help with code formatting and ensuring that your commits build successfully. Note that these can sometimes take a moment to run and will potentially modify files in your working tree. For more information, see the git hooks documentation.
This automatically reformats all files with staged changes to match the project guidelines.
To install (or update), run the following commands in a terminal. WARNING: this will overwrite any previous custom git hook.
rm .git/hooks/pre-commit
./git-pre-commit.sh
This will run the hook and place a copy in your .git/hooks/ folder.
Future commits will always run the hook.
To uninstall:
rm .git/hooks/pre-commit
This automatically checks all modified files against the project guidelines and only allows you to push valid commits.
To install (or update), run the following commands in a terminal. WARNING: this will overwrite any previous custom git hook.
rm .git/hooks/pre-push
./git-pre-push.sh
This will run the hook and place a copy in your .git/hooks/ folder.
Future pushes will always run the hook.
To uninstall:
rm .git/hooks/pre-push