Prepack: List of recommended reading for new contributors

Created on 7 May 2018  路  8Comments  路  Source: facebook/prepack

Prepack happens to be one of those projects where knowledge of certain areas of computer science (partial evaluation, program specialisation in general, abstract interpretation etc) are vital to understand how things work under the hood. Personally, in the past I have been able to make small contributions to the interpreter, but when it comes to the serialiser, things went over my head.

While the homepage does try to explain how these concepts are put together, a list of recommended reading books/articles would really help. I found Partial Evaluation: Practice and Theory to be a great start (of course after Wikipedia). Suggested reading for the theoretical concepts involved would help us a lot.

question

Most helpful comment

I started a wiki page on with suggested reading material:
https://github.com/facebook/prepack/wiki/Suggested-reading

Let me know if that helps, or what areas you'd like more information about.

All 8 comments

I started a wiki page on with suggested reading material:
https://github.com/facebook/prepack/wiki/Suggested-reading

Let me know if that helps, or what areas you'd like more information about.

Thank you so much :) The wiki was exactly what I had in mind. I'll close this issue for now re-open it if I feel the need for more material.

Should we point to Wiki from somewhere? In my experience Wiki pages aren鈥檛 always easy to find. It鈥檚 not obvious when a project actually uses the Wiki so many don鈥檛 look for it.

I would suggest having a file like CONTRIBUTING.md that points to the relevant resources.

Fair point. Or a section in the ReadMe.md itself pointing to the Wiki?

I don't think it matters where it is as long as:

  • there's a centralized place with links to all contributing docs
  • we link to that place from other entry points people might consider (README, Contributing.md, website)

I think it's fine if Wiki home page plays that role, let's just make sure we link to it everywhere.

I think should make a wiki homepage and link to it from the website and the README and Contributing.md entry points.

Now that the Readme points to the wiki, I think we can close this - at least for now. Feel free to reopen this if there is a need.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

vojtechkral picture vojtechkral  路  5Comments

jacktuck picture jacktuck  路  3Comments

NTillmann picture NTillmann  路  4Comments

aligoren picture aligoren  路  6Comments

jtenner picture jtenner  路  5Comments