Submitting to a Contest - Taaseen-Ali/OpenAI-Gym-Car-Race GitHub Wiki

Make sure that you:

1. know the contest branch you'd like to submit to (e.g. contest/<year>)
2. have a config.py file that contains your custom values representing your entry to contest
3. [optional] have a reward function to be used alongside your updated config file

The following are steps to guide you in creating a pull request with your updated configuration for a contest

1. Fork this repository into your own account (1 fork per team)

2. Checkout to the contest branch you want to submit to (i.e. git checkout contest/2021). Note that this will require you to stash/commit any previous changes that you may have made.

3. Add a new file into the contest folder named <my_team_name>.py. Copy and paste your updated configuration into this file.

4. Follow the comments in run_contest.py to complete your submission. There are some examples in the file to help you

5. Commit your changes and push them to your forked repository

   git add contest/<my_team_name>.py
   git commit contest/<my_team_name>.py run_contest.py -m "add team submission for <my_team_name>"
   git push origin <contest_branch>

6. Create a pull request against the contest branch from your fork. Enter "Contest submission for <my_team_name>" as the title of your request and mention your team members as well as any relevant extra information (like methods you used/research you did) in the description.