Contributing

Hi there! We're thrilled that you'd like to contribute to GitVision. Your help is essential for keeping this Eurovision-themed workshop great.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Prerequisites for running and testing code

These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.

Install Flutter through download | through package manager
Set up API tokens in gitvision/lib/config/api_tokens.dart (copy from example file)
Run the workshop setup: cd gitvision && ./workshop-start.sh

When contributing Eurovision-related content, please ensure:

Accurate Information: Verify song titles, artists, years, and countries are correct
Historical Context: Handle country name changes appropriately (e.g., Yugoslavia → Serbia)

[Fork][fork] and clone the repository
Set up the development environment (see prerequisites above)
Create a feature branch: git checkout -b feature/your-feature-name
Make your changes and test the workshop flow end-to-end
Ensure flutter analyze passes with no issues
Push to your fork and [submit a pull request][pr]
Pat yourself on the back and wait for your pull request to be reviewed and merged

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
Write a good commit message.
Test your changes with the full 120-minute workshop flow.
If adding Eurovision content, verify accuracy.