aspl-lang/aspl

contributing: add more information about the code/repo structure and how to contribute

Open

#10 opened on Feb 12, 2025

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C (6 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (30 stars)
PR merge metrics
 (PR metrics pending)

Description

This could include things like:

  • The structure of the compiler (especially the different passes and backends)
  • The structure of the standard library
  • How to properly format titles of issues and PRS as well as commit messages
  • Code-style guidelines (no EOF blank line, when to put spaces before operators, ...)
  • ...

Contributor guide

Research direction
Familiarize yourself with the ASPL repository structure by exploring the compiler passes and standard library. Review existing contributing guidelines and note missing sections. Propose additions covering code structure, commit message format, and code style.
Tech stack
c
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80