vrx_2023 submission_process

Submission process

Submissions will be made though the vrx-events repository. All registered teams must perform the following steps to submit solutions to each phase:

1. Fork the `vrx-events` repository

Click on this link.
You can choose a custom name for the repository, but here we will leave the default value vrx-events.
After you finish the fork process, you should have a copy of vrx-events on https://github.com/<yourname>/vrx-events.

Note: Throughout these tutorials, substitute <yourname> with your GitHub account username.

2. Clone the `vrx-events` repository

Now that you have forked the VRX events repository, download a local copy and move into the root of the repository:

git clone [email protected]:<yourname>/vrx-events.git
cd vrx-events

3. Add your submission files

Navigate to the event where you plan to participate (e.g.: 2023/phase2_dress_rehearsal) and create a directory with your team name:

cd <year>/<event>
mkdir <teamname>
cd <teamname>

Substitute <year> and <event> with the year and event that you plan to participate, and <teamname> with your team name.
Copy all files required for the event into your team folder.
Follow the instructions detailed in the event page for the complete list of files to be submitted.

4. Test your submission (Phases 2 and 3 only)

Before submitting your pull request we recommend that you validate your submission and evaluate it to verify that it works as expected. See the following tutorials for a walk through of this process:

5. Submit your pull request

In preparation for your pull request, create a branch in your repository that will keep track of the files you want to submit, e.g.:
```
git checkout -b 2023_rehearsal_team_osrf
```
Use the add command to tell git you want to add the files you just copied to the new branch you created:
```
git add *
```
(Note that the files will not actually be added until you commit your changes.)
Verify that you added exactly the files you want (and no others):
```
git status
```
Caution: This command will give a list of the changes that git will make on the next commit. If it is not what you want (especially if you accidentally added too many files), don't proceed to the next step! You will need to troubleshoot and correct the problem before moving on. If you are new to git, you may find these tips helpful.
Commit changes to your local git repository:
```
git commit -m "Team OSRF submission for 2023/rehearsal event."
```
- The -m "TEXT" argument provides a commit message/comment. This is required.
Push the local changes to your remote (online) repository.
```
git push -u origin 2023_rehearsal_team_osrf
```
Open a pull request for vrx-events.
- Navigate to your online pull request page at the following link: https://github.com/<yourname>/vrx-events/pulls/new
- Click "New Pull Request".
- Check the left two boxes to make sure your pull request is targeted at the osrf/vrx-events repository master branch.
- The two boxes on the right should specify the branch of your fork where you added your submission files.
- Be sure to include the year, name of the event and your team name in the title. E.g.: 2023 rehearsal team_osrf
- We're going to assume that your solution works for all the tasks. If that's not the case, please let us know in the description. For example: "This submission tackles tasks #1, #2 and #3 but it won't work for tasks #4, #5 or #6". This information is very useful for us because we'll run an initial evaluation of your submission before approving your pull request. If we observe that your WAM-V isn't moving, we'll reply in your pull request to confirm if that's expected or you have some issue in the Docker image unless you warned us before in the description.
- Click on the Create pull request button and wait for your pull request to be approved and merged.