LispCookbook / LispCookbook/cl-cookbook

Call for unifying code style

Open
#209 2 comments 0 reactions 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 found some glitches in the source code.

For example:

  • Some titles are like Doing Something but some others are Doing something.
  • Some people (like me) fill the source content within 80 columns but some do not.
  • Usage of hyper links is different ([text](http://example.com vs [text](link))

IMHO it is better to set a standard style and make everybody obey it.

Do you think it is necessary to do so?

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

No files or tests are named. Start by reviewing the cookbook's source content for title capitalization, line width, and hyperlink styles, then determine whether a single standard can be agreed on. Done means the style guidance is documented and the affected content follows it.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
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.