Thank you for considering contributing to our algorithmics course materials! This document provides guidelines and instructions for contributing.
- Use the issue tracker to report problems
- Describe the issue in detail
- Include minimal examples that demonstrate the problem
- Specify which course and document the issue relates to
- Use the issue tracker to suggest improvements
- Explain why the enhancement would be useful
- Provide examples if possible
- Fork the repository
- Create a new branch (
git checkout -b feature/YourFeature) - Make your changes
- Run the build system to ensure everything compiles
- Commit your changes (
git commit -m "Add some feature") - Push to the branch (
git push origin feature/YourFeature) - Create a Pull Request
- Use 4 spaces for indentation
- Place each sentence on a new line (makes Git diffs more readable)
- Use meaningful labels for equations, figures, and references
- Follow the naming convention for files:
- Course files:
chapter_XX.tex - Exercise sheets:
td_XX.tex - Main files:
XX_main.tex
- Course files:
\begin{theorem}[Fundamental Theorem of Calculus]\label{thm:ftc}
Let \(f\) be continuous on \(\ff{a,b}\) and let \(F\) be an antiderivative of \(f\).
Then:
\begin{equation*}
\int_a^b f(x)\der x = F(b) - F(a)
\end{equation*}
\end{theorem}- Place all images in the appropriate
assets/directory - Use relative paths in includes
- Keep course-specific macros in the course's
assets/directory - Place shared macros in
src/common/macros/
- Complete TeX Live or MiKTeX installation
- Python
- Git
# Build all materials
./build.pyFeel free to contact Ivan Lejeune with any questions or concerns.