This repository contains all code of the students working at the Institut of Assembly Technology of the Leibniz University Hannover.
- Fork this repository by clicking on the
fork
-button: . Afterwards clickCreate fork
. - Click on the
README.md
-file and then click on the edit-button: - Add another line to the table at the bottom. (You can copy the line of the student above for the structure)
- Column
Id
: Increase the previous Id by 1. Please memorize theId
, as it will be used in future steps. (always three numbers, f.e.007
or069
) - Column
Thesis title
: Insert the title of your thesis. - Column
Description
: Explain in one sentence what algorithm or code you developed in your thesis. - Type in a meaningful commit message and commit the changes.
- Go to chapter [Pull Request](### Pull Request) and immediatly create a pull request to add yourself to the table so other students know a specific id is occupied. After creating this pull request go to the chapter [How to add your code](## How to add your code) and perform the steps of one of the two methods.
There are two methods for adding your code. The first is only using the Github-Webinterface. The second option is by cloning the repository and working on your computer. We advice to use the second method.
- Navigate into the
student_code
-folder. - Add a folder in
match_student_code/student_code
with aREADME.md
file by clicking theAdd file
-button: and selectAdd new file
. - Think of a name that summarizes your work/algorithm. This name is used in the next step.
- Behind
match_student_code/student_code/
typeId_NameOfStep10/README.md
. Insert theId
from the chapter [Add yourself to the overview table](## Add yourself to the overview table) and the name you thought of fromstep 3
. - Navigate into the created folder
Id_NameOfStep3
. - Add all packages and additional files into the folder by clicking the
Add file
-button: and thenUpload files
. Drag and drop all folders or files from the File Explorer into the box on the web interface to upload. (On Windows it is Windows Explorer on Ubuntu it is File Manager) - Type in a meaningful commit message and commit the changes.
- Add a
README.md
-file in your folder (seestep 4
) and use the structure of the example-README-file in000_ExampleFolder
. - Fill out every necessary information in the copied structure and add any more details you want to describe or use your package.
- Type in a meaningful commit message and commit the changes.
- To finish, please jump to the chapter [Pull Request](### Pull Request) where you create a pull request to the main repository.
- Clone the repository to your PC by executing the
git clone
-command with the forked repository. - Think of a name that summarizes your work/algorithm. This name is used in the next step.
- Create a folder in
match_student_code/student_code
namedId_NameOfStep2
. Insert theId
from the chapter [Add yourself to the overview table](## Add yourself to the overview table) and the name you thought of fromstep 2
. - Add all packages and additional files into the folder, f.e. by drag and drop.
- Add a
README.md
-file in your folder (seestep 3
) and use the structure of the example-README-file in000_ExampleFolder
. - Fill out every necessary information in the copied structure and add any more details you want to describe or use your package.
- Type in a meaningful commit message and commit the changes.
- If not already done, push the changes to your forked repository.
- To finish, please jump to the chapter [Pull Request](### Pull Request) where you create a pull request to the main repository.
To merge your changes/added files into the official match-ROS repository, we need to create a Pull Request:
- Navigate to the start page of your forked version of the
match_student_code
repository. - Check if the last commit message is by you. If not, you need to go into your forked version of the
match_student_code
repository. - Click on the
Pull Request
-button: and thenNew Pull Request
on the right side. - Compare two things with the following picture. Firstly, does the
base repository:
andbase:
match excactly. Secondly, is your forked version of thematch_student_code
repository listed behindhead repository
and is the branch selected that you commited your code to.
- Check if all changes are listed correctly. Did you add all necessary packages? Did you add all additional Matlab or Python scripts?
- Create the pull request by clicking on the
Create Pull Request
-button. - Inform your supervisor about the newly created pull request.
Id | Thesis title | Description |
---|---|---|
000 | Example Folder | This folder contains templates and examples how it should look like |
002 | Planung und Glättung von Pfaden für Formationen nicht-holonomer mobiler Roboter | Path planning with voronoi diagrams and smoothing with quintic bezier-splines |