Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

25 lines (18 loc) · 1.12 KB

Contributing

Hi there! I am thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Setting up the environment

  1. Fork and clone the repository.
  2. Configure and install the dependencies: npm install (you need to have node.js installed, I use v14.17.4).
  3. Run the project with npm run start

The project is built using Angular 9 and NgRx 10. Check the official guides if you need help.

To edit the data (i18n or Wingspan card list), python with Jupyter notebook is required to transform it to the json files. New files in generated folder have to be formatted and moved to the assets folder.

Submit a pull request

  1. Make your change, add tests, and make sure the tests still pass.
  2. Make sure to test the app locally.
  3. Create a new branch: git checkout -b my-branch-name.
  4. Push to your fork and submit a pull request.
  5. Pat your self on the back and wait for your pull request to be reviewed and merged.