Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
A HACKING.adoc file with hacking advice #925
I think that the README should present the compiler distribution, but does need to contain information that is only relevant to people hacking on it, currently it's trying to do a bit of both. There are various things on how to effectively hack that are folklore knowledge and we could profitably store in this file.
Cc @johnwhitington, our precious README steward.
I guess I didn't know or forgot about it, sorry. (The fact that I didn't reply to your PR suggest that it was made in the time window where I disabled notification for new PRs in a desperate and ultimately doomed attempt to spend less time doing OCaml stuff.)
My HACKING.adoc file was sitting in a branch somewhere on my computer and I wanted to have it today as I was using the
Can we merge our files? Are you volunteering it do it, or should I add it to my TODO list?
Hope some of this is helpful - up to you if you'd prefer to change it here or in a subsequent GPR!
Thanks a lot @dra27 for the review. I acted on your comments.
I think I'll wait a bit more in case anyone has feedback, but then I'll go ahead and merge because (1) the stuff in there is already useful so why wait and (2) contributions of new content to these documents are best made by creating new PRs on top of the current state.