Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure the whole thing #159

Open
cyberhck opened this issue Dec 1, 2017 · 1 comment
Open

Restructure the whole thing #159

cyberhck opened this issue Dec 1, 2017 · 1 comment

Comments

@cyberhck
Copy link
Contributor

cyberhck commented Dec 1, 2017

We really should try the following so the entire repository is maintainable.
We add programs into separate individual files. We can add tests if applicable, or we try to compile and see if that worked. Additionally, we can use make to test a few more things, probably passing set of arguments should yield certain result.

I'd say for example, we've a quadratic equation program, we write in a C file, and not on LaTex or md file, we write in a good way easy to read and maintain, probably chunk them into functions, and if possible, unit test them, else at least do a compile.

thoughts? @fsmk/vtu-lab-manual-maintainers

If everyone agrees, I'll add a sample program (probably refactor a program) with all the tests, and structures over the weekend and send a PR then we can slowly migrate and make it really easy to maintain, easy for students to follow, and a consistent code style.

I'm not sure what's going on with syllabus, or does it make sense to only do this with newer syllabus at first, and slowly refactor the older ones later?

@cyberhck
Copy link
Contributor Author

cyberhck commented Dec 1, 2017

note to self: think code linting, testing on travis, building the whole file, using Makefile.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant