search

SageMathOER-CCC / sage-discrete-math

An open textbook for Discrete Mathematics with SageMath, as taught at the City Colleges of Chicago
https://sagemathoer-ccc.github.io/sage-discrete-math/
Other
2 stars 2 forks source link

Readme #109

Closed Samuel-Lubliner closed 3 weeks ago

Samuel-Lubliner commented 1 month ago

@boughrira Thank you for bringing up the changes to the readme. Part of the goal of the readme is to encourage anyone, regardless of experience, to feel comfortable contributing, including current Discrete Math students using the book. Please let me know if you have any other suggestions.

Samuel-Lubliner commented 3 weeks ago

@boughrira Yeah we can include these changes, but I have some questions.

I am not familiar with .gitattributes. What does * text=auto eol=lf do?

I think it is a good idea for us to mention the pdf build. Do you think we should also mention the workflow?

https://github.com/SageMathOER-CCC/sage-discrete-math/blob/main/.github/workflows/pretext-cli.yml

This is the workflow I made to accomplish the automated PDF generation when we merge to main. I am also open to feedback if you think there is a better way.

Also the devcontainer handles the installation of LaTeX engine and all font dependencies. However if you don't want to work in a container, yes they will need to be installed manually.

boughrira commented 3 weeks ago

@Samuel-Lubliner

I am not familiar with .gitattributes. What does * text=auto eol=lf do?

That's simply to force git to use the same NewLine marker across different OS (LF: LineFeed is the default for Linux/Mac systems and CRLF: CarriageReturn + LineFeed is for Windows-based systems -which adds an extra hidden character). Otherwise, someone using VSCode on Windows machine, for instance, may notice ^M in the git diff which is being added by the IDE set to use CRLF under Win OS.

Another thing I've noticed is the mix-use of Tab and Space for indents (as well as using different indent-size in different files) and it's causing some issues in the printed version (I have the change/fix on a branch and will open a PR to fix the issue), and I think we should have a hook configured on commits to format the code file for consistency and improve the code quality.