Skip to content

An algorithmic project in C consisting in organizing a workshop.

Notifications You must be signed in to change notification settings

toro-nicolas/organized

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Organized 🗃️

Table of contents 📑

Description 📝

The Organized is a project carried out in solo, during our 1st year in EPITECH Grand Ecole program.
Its purpose is to create in C a workshop organizer.

Usage ⚔️

You can run the organized like this :

./organized

Result 🚩

The result of this project is an perfect Organized.
If you discover a problem or an error, don't hesitate to create an issue and report it to us as soon as possible.

my.epitech.eu result

Category Percentage Numbers of tests Crash
Algorithm app 100% 8/8 No
Basics 100% 4/4 No
Optimization 100% 7/7 No
Parsing 100% 3/3 No
Robustness 100% 7/7 No
Results 100% 29/29 No

Tests and code coverage

Unit tests were performed using criterion.
In this project, only the library code is covered. Unit tests are still to be performed, but a large part of the code is already covered.

You can compile the project and run the unit tests with this command :

make tests_run

Compilation 🛠️

You can compile the project with this command :

make

If you want clean the project, you can run this command :

make fclean

You can clean and compile the project with make re.

You can compile the unit tests with this command :

make unit_tests

Code mandatory 📦

  • You'll need to create a branch where you'll push your code. Once you've completed your tasks on this branch, we'll work together to merge it and check that everything works.
  • Every function you add must be code-style.
  • Before merging, you'll need to check that all unit tests pass by running make tests_run.
  • Each commit will contain [+] or [-] or [~] followed by a message
    • [+] : Add feature
    • [-] : Delete feature
    • [~] : Edit feature

Of course, in exceptional cases, we may depart from these rules.

What's next ? 🚀

  • Add help section
  • Add github actions
  • Improve the memory management
  • Add a documentation for each function
  • Add unit tests on each piece of code

Contributors 👤

This project was carried out alone by Nicolas TORO.