aptos-labs / aptos-labs/aptos-python-sdk

[Feature] Sample env file in the Codebase

Aperta
#47 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Python
Stelle
33
Fork
24
Merge medio
22m
PR unite (30g)
1

Descrizione

🚀 Feature Request: Add a .env.sample File

Description

Introduce a .env.sample file to the repository to standardize and simplify the setup process for managing environment variables.

Motivation

Managing environment variables without a clear template can be challenging, especially for new developers. The absence of a .env.sample file leads to confusion about:

  • Which variables are required.
  • The purpose of each variable.
  • The expected format or example values.

Adding a .env.sample file will streamline onboarding and reduce errors caused by misconfigured or missing variables.

Proposed Solution

Create a .env.sample file in the root of the repository with the following:

  • Placeholders for all required environment variables.
  • Comments explaining the purpose of each variable.
  • Example values (if applicable).
Example
# Required API key for authentication
API_KEY=your_api_key_here

# RPC endpoint URL
RPC_URL=https://your.rpc.url

# Private key for signing transactions
PRIVATE_KEY=your_private_key

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia ispezionando il repository alla ricerca di riferimenti a variabili d’ambiente e di istruzioni di configurazione esistenti. Crea il file .env.sample nella root con segnaposto, commenti e valori di esempio per le variabili richieste identificate. Il lavoro è completato quando il file documenta le variabili necessarie per la configurazione senza esporre credenziali reali.

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

Valutazione

Stack tecnologico
python
Ambito
developer-experience
Tipo di issue
Funzionalità
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.