ab1908 / cs-books Goto Github PK

I am currently preparing the branch for Compiler Design, so just wanted to let the users know, so that there is no confusion. I think this issue can be used to declare upcoming work, until a time, that the repo is no longer in active development. What say @AB1908

Submit all issues regarding formatting, categorisation and structure of the repository here! Inelegant, but I don't have a fancy channel for this stuff. 🤷‍♂️

Yell out any ideas you have.

The way courses are linked in notes seems rather clunky and unreadable, which violates a core aim.

The contributors ( or the stargazers for that matter) need to know that the master branch is not being altered at this point of time, before a certain structure is present in the curriculum. All changes are being made to the dev branch.

A more efficient way to link resources is required. When linking the resource in notes and descriptions, I have used a shorthand notation. However, for the end user to know which university it links to, or in the case that the user wishes to see all links only, I have included them at the end with their full link description.

A future consideration is to create a table of the links to the universities and mark which ones have lectures available for reading, lecture videos, assignments, projects, and so on.

Submitting the reader's experience of a particular book is highly encouraged. However, at the time, there is no appropriate place to include these personal notes. At the moment, my idea is to migrate all personal experience to a separate file personal-experiences.md, with the contributor tagging their feedback with a handle. Hopefully, this would keep the actual book list free of personal opinions, which are only mine as of now. Please suggest other alternatives if you have 'em!

Now that, the project has started attaining a structure, I guess the contents of readme can be migrated to curriculum.md and the new topics be added there only. It doesn't make sense to have two copies of the same does it?

So, whenever you are going to accept contributions, I guess, you need people to branch out the name of the course they are interested to write about. The branch name should ideally be /name1-name2-.., for e.g. /theory-of-computation .
Any ideas/suggestions about the format of the text? So that I can incorporate the template in contributing.md ?

Let me get this straight. Contributions are not welcome at this point of time? xD

An idea I have is to include essential reads in the readme, with the more detailed list for those who desire it. It'd help anyone who wanted a quick look and not wanting to read all of my crappy comments.
@AsliRoy , what's your opinion?

The current Pull Request Template seems pretty cluttered and is extremely annoying every time I have to open a PR. As of now, I plan to move the formatting style to it's own file which can be referenced as needed, while the PR Template will just contain a brief overview. Suggestions welcome.