Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Swiatlon committed Jan 3, 2025
1 parent c46289e commit f5bb360
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
Binary file added .github/screens/ci.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,20 @@ docker-compose down

---


## **CI/CD Pipeline with GitHub Actions**

Our project leverages **GitHub Actions** for Continuous Integration (CI), ensuring a robust and streamlined workflow for code quality checks and test automation. Every pull request undergoes multiple checks, including unit tests, linting, and builds. Below is an example of the CI checks in action:

![GitHub Actions CI Workflow](./.github/screens/ci.png)

### **Key Features:**
- **Comprehensive Checks**: All pull requests must pass the CI checks before being eligible for merging.
- **Review Requirement**: At least one approving review is mandatory, ensuring high code quality and collaboration.
- **Merge Blocking**: Merging is blocked until all required checks are successful, as shown in the screenshot above.

This ensures that only well-tested, high-quality code is merged into the main branch. For more details, you can view the CI workflow in the [example pull request](https://github.com/Swiatlon/University-FN/pulls).

## 📝 **License**

This project is open-source and licensed under the **MIT License**. Check out the full details in the [LICENSE](LICENSE) file.
Expand All @@ -156,4 +170,4 @@ This project is open-source and licensed under the **MIT License**. Check out th
If you have any questions or feedback, feel free to reach out:

- Email: [your email address] 📧
- Open an issue on [GitHub Issues](https://github.com/Swiatlon/University-FN/issues) 💬
- Open an issue on [GitHub Issues](https://github.com/Swiatlon/University-FN/issues) 💬

0 comments on commit f5bb360

Please sign in to comment.