-
Notifications
You must be signed in to change notification settings - Fork 2
Add side menu to the main page #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,42 @@ | ||
| # Guide for students | ||
| # Guide for Students | ||
|
|
||
| Brainhack School students, please find the instructions regarding several important points that will facilitate your progress with the school | ||
|
|
||
|
|
||
| ### How to prepare my project pitch presentation? | ||
|
|
||
| Please find the project pitch template [here](https://docs.google.com/presentation/d/11QnKJ7L8IM6aCF3WbgtxDzIbc3P_IplVP9bItvxZtWg/edit?usp=sharing). Please make a copy of the presentation at your own local and edit as necessary. You are free to choose your color/font/template scheme. Keep it brief and short, that would not go longer than the recommended number of slides. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ...short, and no longer than... |
||
|
|
||
|
|
||
|
|
||
| ### How to create my project repository? | ||
|
|
||
| Please follow the instructions in the [“Using Git and Github” module](https://school-brainhack.github.io/modules/git_github/#:~:text=wants%20a%20refresher!-,Exercise,-send%20a%20request) exercise that will show you the steps to create a repository under [Brainhack School project organization](https://github.com/brainhack-school2023). | ||
|
|
||
|
|
||
|
|
||
| ### How should I structure my project repository? | ||
|
|
||
| Please do have a look at the repositories from the [previous year’s project Github organization](https://github.com/brainhack-school2022 ) to get an idea. In general, we expect you to have a readme file where you can describe your project with goals and deliverables, resources, references and code base that you will be using during your project development. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. space between link and ), will it still link correctly? |
||
|
|
||
| ### How should I create a project issue template? | ||
|
|
||
| Please visit the [Brainhack School Projects](https://github.com/brainhack-school2023/brainhack_school_projects) repository and choose [issues](https://github.com/brainhack-school2023/brainhack_school_projects/issues). Click on the new issues then you will see “Project Submission Template”. This will open a template issue format with several questions for you to fill in for your project. Do not worry you can always change, edit/remove what you added to the issue. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Click on 'new issue', and you... |
||
|
|
||
|
|
||
|
|
||
| ### How can I add labels to my project issue? | ||
|
|
||
| On the right hand of the issue, you will find the labels. Please make sure that you might not find labels one-to-one matching your project description, but some approximate ones. Therefore use the ones you feel like it represents your project the best. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. delete 'Please make sure that', so it reads:. ... You might not find... |
||
|
|
||
| Please do not forget to add the label that represents the name of your hub! | ||
|
|
||
|
|
||
| ### Why should I add labels to my project issue? | ||
|
|
||
| We highly encourage our students to expose themselves to their peers’ projects and learn from each other, share their constructive feedback and help each other. These labels, therefore, will help your peers to search through some basic keywords to find your project and engage with you easily. | ||
|
|
||
|
|
||
| ### How can I submit the latest project template? | ||
|
|
||
| When that exciting day arrives please go to [Project Template](https://school-brainhack.github.io/project/template/) page that explains every single step that you have to follow to complete your project submission successfully. This will create a page for your project that will showcase all the details and outputs of your project. Please do have a look at the examples from the [Projects page](https://school-brainhack.github.io/project/) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,3 +6,5 @@ | |
|
|
||
| STUDENTS | ||
| ORGANIZERS | ||
| MODULES | ||
| INSTRUCTORS | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
...the school below.