Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Project idea: purposeful alias names - a require aliases lookup website

Aperta
  • Qualcosa non va?
#392 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
clojure
Ambito
full-stack, web-dev

Direzione di ricerca

Inizia dal corpo dell’issue e confronta le tre opzioni di implementazione proposte: una REST API, una SPA autonoma in ClojureScript oppure una REST API in ClojureScript con Reitit. Definisci l’ambito del progetto, l’approccio alla persistenza e la destinazione del deployment prima dell’implementazione. Il lavoro è completato quando una ricerca nella libreria restituisce alias appropriati e comuni, la motivazione e gli eventuali riferimenti alle funzioni consigliati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

project

A website where a library name can be entered and it returns the recommended alias to be used in an ns (:require ,,,) form.

Rationale
Whilst extremely common libraries that appear in the vast majority of projects can have more cryptic aliases, because they are well used. Most libraries should express the intent of their use to help the code remain clear and unambiguous

Concept
A website with a simple library lookup which returns purposeful names that can be used for an alias. A description of why the alias name was chosen, explaining how it captures the purpose / intent of the functions in that library

Results would also mention highly common aliases that are used, such as d for datomic alongside the purposeful names, so developers can have a choice. Either use a cryptic alias and assume others are aware of its purpose

Recommendations for some libraries would include referring specific functions instead of (or as well as) using an alias, e.g. clojure.test typically refers [is deftest testing]. This result would also include a description as to why this approach is preferred, as the namespace is focused on the use of this library - i.e. writing a test

Implentation options

  1. REST API so that a range of clients could be used (webUI, editor, command-line tool, etc) with persistence store (or remote store) - deployed on Heroku
  2. Self-contained ClojureScript Single Page Application with external data store (e.g. firebase, etc.) - Deployed on GitHub/GitLab pages
  3. ClojureScript REST API with Reitit with remote persistence store - deployed on GitHub/GitLab pages
Lingua principale
Makefile
Stelle
117
Fork
36
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di practicalli/clojure

Tutte le issue di practicalli/clojure

Issue simili

Altre issue su Web Dev

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.