practicalli / practicalli/clojure

coding practices - naming conventions

Open
#97 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
117
Forks
36
PR merge metrics
No merged PRs in 30d

Description

use descriptive names for namespaces, funcitons, global and local symbols

names should elaborate on the contenxt of the namspace, function data structure

avoid single character tor terse names - never use a single character name. if you cant think of a name, then you dont understand something fully.
For example if requireing clojure.alpha.spec into a namespace then use the alias spec.

If you have multiple libraries that could be used to do the same task, then use an alias that describes the purpose or intent of that library. This makes the alias retain its meaning when changing the library (and avoiding refactoring the whole namespace).

Single character names add more cognitive load when reviewing and working on existing code.
Single characters lead to conflct of meaning.

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

The issue names no file, test, or entry point, so first locate the repository guidance that covers coding practices and naming conventions. Update the relevant guidance to address descriptive namespace, function, symbol, and alias names; done means the stated conventions are documented without ambiguity.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.