CI/CD Pipeline and Documentation

Shanaya Bharucha and Emily Rosenfeld

We made sure that Pylint tests worked and that there was 80 percent code coverage for the CI/CD pipeline. We also made sure to go through the code and add documentation so viewers can understand what us developers wrote.

The CI/CD pipeline is a feature of GitHub that runs various tests before allowing a branch to be merged into main. Our specific pipeline was only CI, as we were never delivering the product to our client until end. We added in a pylint checker, which ensured that all of our code followed clean coding principles and avoided certain code smells. Besides just running our unit tests to ensure the website was working was we wanted before the merge, we also integrated a code coverage tracker, to ensure that our code was always 80% or more covered by the unit tests that we wrote. Code coverage ensures that developers aren't making large changes to the website functionality without writing new tests that check the website. Overall, our CI pipeline helped keep our main branch protected and free from errors & bad coding practices.