EpiTools is a suite of four tools specifically designed to enhance and simplify the workflow at Epitech wen working on C projects. These tools include EpiForge, EpiStyle, EpiCheck, and EpiTemplate, each with a unique set of features to cater to different aspects of your projects.
EpiForge is an automation tool integrated with the EpiTemplate project's Makefile. This tool is incredibly handy as it auto-updates the Makefile files, eliminating the need to manually write all file paths.
EpiStyle is a coding style tool with a user-friendly interface. It helps you maintain coding standards and improves readability across your projects.
EpiCheck is a function-checking tool designed to identify banned functions and all sorts of function calls your program makes. It aids in ensuring your code's compliance with Epitech's coding standards.
EpiTemplate is a tool that copies the EpiTemplate template into your chosen repository. This tool simplifies the process of setting up new projects based on the standard EpiTemplate.
To install the EpiTools suite, follow these steps:
-
Choose a directory where you want to store your Epitech projects, such as
EpiTech. -
Clone the EpiTools repository into the chosen directory:
$ git clone <EpiTools-repo-url> Epitools
This will create a new folder named Epitools containing the EpiTools suite.
EpiForge is integrated with the EpiTemplate project's Makefile, and it automatically updates the Makefile files. Its used by the EpiTemplate Makefile
EpiStyle is a coding style tool with a user-friendly interface. Its used by the EpiTemplate Makefile
EpiCheck is a function-checking tool designed to identify banned functions and various function calls in your program. Its used by the EpiTemplate Makefile
EpiTemplate is a tool used to clone the EpiTemplate template into your chosen repository.
PS : tmp folder can be used to store the coding style docker
We appreciate all contributions to the EpiTools project! Here are some guidelines to help you get started:
-
Fork the repository: Start by forking the EpiTools repository to your own GitHub account.
-
Clone the repository to your local machine: Use
git clonealong with the URL of your fork. -
Create a new branch: Use
git checkout -b your-branch-nameto create a new branch for your changes. -
Make your changes: Make changes to the code to fix bugs, add new features, or improve functionality. Please try to follow existing coding conventions and style.
-
Test your changes: Ensure that your changes do not introduce any new bugs and that all existing functionality still works as expected.
-
Commit your changes: We use the gitmoji convention for commits. Start the commit message with an emoji, followed by a general text and a detailed comment. Use
git commit -m ":emoji: General text" -m "Detailed comment"to commit your changes to your branch. -
Push your changes to GitHub: Use
git push origin your-branch-nameto push your changes to your fork on GitHub. -
Create a pull request: Go to the EpiTools repository on GitHub and create a new pull request. Please provide a clear and detailed description of your changes.
We will review your pull request as soon as possible. Thank you for your interest in contributing to EpiTools!
Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
EpiTools is licensed under the MIT License. This means that you are free to use, modify, and distribute the project, provided that you include the original copyright and license notice in any copy of the software/source. For more details, see the LICENSE file.
If you encounter any problems or have any questions about EpiTools, please create an issue in the GitHub repository. We will try to address your concerns as quickly as possible.
We will do our best to provide assistance and answer any questions you may have about the toolset.
Thank you for using EpiTools! We appreciate your feedback and contributions.