LispCookbook / LispCookbook/cl-cookbook

Suggesting a chapter: compiler-macros

Open
#336 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.1k
Forks
158
Avg merge
6d 3h
Merged PRs (30d)
2

Description

I'm thinking about a chapter dedicated to compiler macros. However, I'm not sure if this should be a chapter or an addition to an already existing chapter about macros. I guess (if we ever plan to have a reader-macros part as well) it makes sense to make them both parts of the macro chapter...?
Anyway, I'll write a sketch (composed from several sources) and PR it. We'll see how big it gets. Of course if anybody has anything similar in mind, suggestions are welcome.

Something connected to it is a series of explanations about load-time values -- not sure where to put this one.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing macros chapter and the cookbook’s chapter structure before deciding where compiler macros and load-time values belong. Prepare a sourced chapter sketch, then use its size and overlap with existing macro material to determine whether it should stand alone or be integrated; done means the proposed placement and scope are clear enough for a PR.

Written by the indexing model from the issue text.

Assessment

Domain
compilers, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.