Project submission guide

TOC

---

Project Submission Guide

To submit your project, you should (1) upload your slides of wrap-up presentation, and have (2) a public repository that contains your deliverables, such as code and report (or Jupyter notebook). Then, you should (3) prepare a introductory page and send a pull request to Brainhack School project pages.

Step 1: Upload your slides

Please upload your slides here

Step 2: Prepare a public repository on Github for your project

1. On your Github, create a public repository named <your_name>_project, and initialize with a README and LICENSE file. (You already did this step in Git and Github module.)

2. Clone your remote repository to your local drive. For example, I would like to clone the files on the repository to my Documents folder under home directory, I can type the following code in terminal. Then, I shall found the files under ~/Documents/<your_name>_project.

   cd ~/Documents
   # change the <USERNAME> to your github account, and <your_name> to your name on your Github repository
   git clone https://github.com/<USERNAME>/<your_name>_project.git 
   cd <your_name>_project
   

3. Open the README.md file. Copy and paste all the contents from Brainhack School Project template. Follow the template and modify the text to show the necessary details for your project. This README.md is a markdown file, so you should prepare it as markdown format, then Github and our website will render this markdown file on webpage as shown here and here. You can learn more about markdown format here, here, and here. You can embed your result figures in the README.md. However, please note that you should copy your figure files into the same folder, and use the relative path to embed your figures.

4. Copy all your deliverables into this folder, stage and commit your changes and push to repository. You have to input your Github username and personalized token as password when it prompt.

    # You should copy all your deliverables to this folder before these lines
    # Otherwise, none of your files were uploaded
    git add -A
    git commit -m "upload my deliverables"
    git push -u origin main
   

5. Check your repository, you should find that all your deliverables were uploaded and README.md was updated.

6. Please fill a form here to let us know the links for your repository and slides, we will evaluate your performance accordingly.

Step 3: Fork the website and send a pull request for your project

1. Go to the Github repository for Brainhack School website. Click the Fork on the page to fork this repository to your account.

2. Leave everything as defaults, and click create fork.

3. You should see that you fork the repository to your account.

4. Clone the forked repository to your local drive. Here, we demonstrated how to clone the repository to Documents folder.

   cd ~/Documents
   # change the <USERNAME> to your github account
   git clone https://github.com/<USERNAME>/school-brainhack.github.io.git
   cd school-brainhack.github.io
   

5. In the school-brainhack.github.io folder, navigate to school-brainhack.github.io/content/en/project

6. Create a folder for your project. The folder name should not have space! You should replace any space to _. Then, copy your README.md (and your figure files if you embedded in README) to the folder. Importantly, please rename the README.md to index.md.

7. Stage, commit and push to your forked repository.

    # change the <your_folder_name> to the folder name for your project
    cd content/en/project
    git add ./<your_folder_name>
    git commit -m "upload a page for my project"
    git push -u origin main
   

8. You should see that you commit the changes for your project on the forked repository.

9. Then, get back to the original Github repository for Brainhack School website. We will send a pull request. (step 1:) First, click the pull request, (step 2:) then click an option called compare across forks, (step 3:) select your <USERNAME>/school-brainhack.github.io.git as head repository. (step 4:) Check all the commits are correct. (step 5:) Then the final step is click the create pull request and confirm the pull request.

10. We will review your pull request, and some revision might be needed. Please be patient and help us to revise your request accordingly.