repository_structure_rtfm.md

Manual for repository creation

Repository types

Before creating a new repository, please decide on the type of repository:

• Repository for education courses
• Repository for educational projects (for example repositories for projects during M1P course)
• Repository for research projects
• Repository for student graduate works
• Repositories with examples and templates (examples of neural network scripting, templates for reviews, etc)

If your repository does not match any of the types, you may be doing something wrong. Please contact the administration of the organization and discuss the purpose of creating your repository.

If your repository falls under more than one type, you are most likely doing something wrong as well. Try to make repositories with only one purpose per repository. There is no need to dump unstructured materials into one repository.

Repository for course

1. Create repository.
2. Write short description, both in Russian and English.
3. Add topic "course" into to your repository topics.
4. Fill the project into table. The repositories are sorted in alphabetical order. The mainatiners are mainly the course professors, not the students that contribute to the repository.
5. Change the status of the course if it's finished and is not planned next term/year.

Repository for educational project

1. Create repository.
2. Write short description, both in Russian and English.
3. Add topic "edu-project" into to your repository topics.
4. Fill the project into table. The repositories are sorted in alphabetical order.

Repository for research projects

1. Create repository.
2. Write short description, English description is necessary, Russian description is optional.
3. Add topic "research" into to your repository topics.
4. Fill the project into table. The repositories are sorted in alphabetical order.
5. Please change the status of your research project in the table according to your actual research status timely.

Repository for graduate works

• Details of the creation of the repository appear every semester on the department’s channels.
• You can use previous year repositories as examples.

Repository with examples and templates

1. Create repository.
2. Write short description, English description is necessary, Russian description is optional.
3. Add topic "examples" into to your repository topics.
4. Fill the project into table. The repositories are sorted in alphabetical order.

Contacts

If you have any question, please write to

• the current repository structure maintainer: Oleg Bakhteev, bakhteev(at)phystech.edu
• organization administration: mlalgorithms(at)gmail.com