Contribution Guide

Setup

1. Currently, to contribute to the project, change the directory to flight-tracker-frontend.

2. Install eslint and prettier for VScode.

https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint

https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

3. Next run the following command: npm install

4. Open settings.json in VScode. You can do this by doing Ctrl+Shift+P and typing 'open settings'

5. Add the following lines to settings.json:

"editor.defaultFormatter": "esbenp.prettier-vscode", "[javascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.formatOnSave": true }

Should look something like this:

5. Eslint and prettier should now be working.

6. Follow the steps in the README located inside flight-tracker-frontend to learn how to run the development build.

Creating an Issue

1. Make sure that the issue has not been resolved and make sure that the issue doesn't already exist.
2. Create a new issue.
3. Add a issue description that descibes how to solve the issue.
4. If you can, try to get someone to approve the issue.

How to Contribute

1. Select an issue that you want to do.
2. Assign yourself to that issue.
3. Move the issue to 'Working On'
4. On your local repo, create a new branch.
5. Implement the changes that you want to make onto the branch. Read the issue description before working on the issue. If the issue is missing a description, you can add a description.
6. Once you are done, select 'New pull request'.
7. Select the branch that you want to merge.
8. Wait for a code review and approval.
9. Merge the branch with the remote main branch.