EpiTemplate is a modular, clean, designed to enhance your workflow at Epitech on C projects. It is part of the EpiTools suite and is specifically designed to work seamlessly with EpiTools to provide an efficient and streamlined programming environment.
EpiTemplate is designed with modularity and cleanliness in mind. By using this template, you can set up new projects easily and efficiently, adhering to Epitech's coding standards. It is also seamlessly integrated with other tools in the EpiTools suite, such as EpiForge and EpiCheck, to further improve your productivity and code quality.
To use EpiTemplate, you need to have Epitools installed. You can automatically install EpiTemplate using a tool in Epitools. If you prefer to install it manually, follow these steps:
- Copy all the contents of this repository into your own project repository.
That's it! You now have EpiTemplate installed and ready to use.
EpiTemplate is designed with modularity in mind. It is divided into multiple systems, each consisting of a header file in the includes folder and a folder in the src folder. You will put your code for each system in the corresponding src folder.
Here's how you can use EpiTemplate effectively:
-
Identify the system you want to work on.
-
Locate the corresponding header file in the
includesfolder. -
Open the
srcfolder of the respective system. -
Write your code for that system in the folder within the
srcfolder.
By organizing your code this way, you can easily manage different components of your project and ensure modularity.
When working with EpiTemplate, we follow the Gitmoji convention for commits. Here's an example of how to create a commit:
$ git commit -m ":emoji: General title" -m "Commentary if needed"
Make sure to use an appropriate emoji from the Gitmoji guide to describe the nature of your changes.
It's recommended to work on branches when making changes to the project. This helps isolate your work and makes it easier to manage and review changes. Once you're confident that your changes are working as expected, you can push them to your branch on GitHub using:
$ git push origin your-branch-name
Before pushing your changes, make sure they do not introduce any new bugs and that all existing functionality still works as expected.
We appreciate all contributions to the EpiTemplate project! Here are some guidelines to help you get started:
-
Fork the repository: Start by forking the EpiTemplate 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 EpiTemplate 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 EpiTemplate!
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.
EpiTemplate 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 EpiTemplate, 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 template.
Thank you for using EpiTemplate! We appreciate your feedback and contributions.