fedor-ivn/capstone_project

Capstone project at Innopolis University:

This is a repo of the Capstone project at the Innopolis University - https://capstone.innopolis.university/

Table of contents

• How to contribute
• Reports evaluation and styling standards
  • Pull requests
  • Shortcodes
    • LaTeX
    • Mermaid (graphs)
    • Other shortcodes

How to contribute

If you do not have the repo on your machine:

• Make sure you have git, hugo, and any code editor installed (VSCode is recommended, but you may use the one you prefer)
• Clone the repository with submodules:

  $ git clone --recursive https://github.com/IU-PR/Capstone_project.git
  

  (Note) If you have already clone this repo without submodules, run this from the source directory

  $ git submodule init && git submodule update
  

Now you can start contributing:

• To start the website localy, run

  $ hugo server --minify --theme=hugo-book
  

• The last line in the terminal output should look like

  Web Server is available at //localhost:some-port-number/ (bind address 127.0.0.1)
  

  Visit localhost:some-port-number in your browser to access your local instance of the website. Now all of you changes in the website's source code should be propageted automatically.

• After you feel you have made enough changes, run
  git add .,
  then
  git commit -m "Your very informative progress report that describes the changes you've made".

Note that this saves and documents changes on your machine only.

Important note!

• Group leads and personal track participants have to be collaborators to do changes in this repo. We will collect a list with your Github ID's and give you the rights
• You need to open your own branch to start making your progress report contributions! Name of the branch should be "group_name/family_name"
• After project is over, we will ask you to make a pull request into a master branch, so we can collect all reports ito a single document/blog
• Don't forget to pull changes from the master branch, we will be publishing weekly tasks and updated information!

Reports evaluation and styling standards:

The project progress reports will be evaluated on a weekly basis, and we are committed to providing you with comments and feedback. While evaluation is subjective, we have established clear criteria for grading reports:

5 - A clearly written report that covers all topics and effectively describes the progress of the project. The report demonstrates accurate and well-organized styling and formatting.

4 - The report is clear, with minor drawbacks. It maintains consistent formatting and styling, presenting information in an organized manner. Can contain minor issues with formatting and styling.

3 - The report is somewhat clear but lacks thoroughness in covering all topics. There may be some formatting and styling issues that need attention.

2 - The report is poorly written and lacks clarity. It fails to adequately cover all topics and contains significant formatting and styling problems.

1 - The report is incoherent and does not provide a clear understanding of the project's progress. It lacks proper formatting and styling, making it difficult to read and follow.

0 - No report

Styling standards

All reports should be submitted in the same branch and the same file of the project. Reports should not include the same text provided from the weekly tasks, but rather take it as a formatting and organizational guide. All provided figures should have legends and explain provided information.

# **Introduction**
Short description of the project with logo, and information on how to connect with the group etc. 

# **Week 1**
## Topic of the Second Order
### Topic of the Third Order

# **Week 2**
## Topic of the Second Order
### Topic of the Third Order

Pull requests

Now that you have made your changes, you will need to properly submit them so that no merge conflicts happen.
To do so:

• Switch to a new branch (if you haven't done that already):

  $ git checkout -b <branch>
  

  Ex: git checkout -b My_Cool_Project_Group_Name
• If you have any changes left uncommited, commit them as usual
• Push your new branch to the server

  $ git push origin <branch>
  

Instructions to merge your branch with the master branch

It should push the branch normally. If not, send the error to the group. Make sure to run git pull before you make any new changes after you've pushed, so that you avoid creating merge conflicts.

• Now go to the github repo
• Press "Pull requests"
• Press "New pull requests"
• Press "Create pull request"
• Describe what have you modified, maybe provide some suggestions for future imporvements
• Once done, press "Create pull request"
• Done! Admins will review your work and merge your changes into the main repo soon

To upload images into your report .md file

Please, create a folder with your group name in /static/your_group_folder/your_images.png

Shortcodes

This blog template uses a handful of shortcodes. Shortcode (in a nutshell) is "mark" inside your markdown code that enables certain features within its code block. For example, you can define a codeblock of LaTeX code that renders LaTeX formulas. You can also define a codeblock that describes a structure of a graph. Below are example of these two.

LaTeX

How to write in LaTeX:

{{<katex>}}
your latex formula
{{</katex>}}

This produces an inline formula. If you want to center your formula, use display property like so:

{{<katex display>}}
your centered latex formula
{{</katex>}}

Latex cheatsheet

Mermaid (graphs)

How to create graphs:

1. Take a look at Mermaid syntax
2. Pick a graph you want to use
3. Write neccesary code

Ex:

{{<mermaid>}}
gitGraph
  commit
  commit
  branch develop
  commit
  commit
  commit
  checkout main
  commit
  commit
{{</mermaid>}}

This will produce a git graph. There are 12 other graph types you can use. Refer to Mermaid documentation for examples.

Other shortcodes

This project's shortcodes and their descriptions can be found in layouts/shortcodes. They all use the same syntax:

{{<shortcode>}}
...stuff/..
{{</shortcode>}}

Try them out if you think they are useful in your progress reports.