AthennaIO / AthennaIO/Template

[Feature]: Write a better contribution guide

Open
#2 0 comments 0 reactions 0 assignees View on GitHub
feature good first issue
Dominant language
TypeScript
Stars
6
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### 🚀 Feature Proposal

Write a better contribution guide with more details on how to fork, clone, run and write implementations and tests in the application.

### Motivation

Our contribution guide is very poor. A better one should be implemented for all kind of developers.

### Example

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing contribution guide and reviewing its current instructions for forking, cloning, running the application, and writing implementations and tests. Done means the guide clearly covers those steps for developers and is understandable without additional context.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.