avantifellows / avantifellows/reporting

feat : Enhance Project Documentation for Open-Source Contribution

Open
#67 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
2
Forks
5
Avg merge
1m
Merged PRs (30d)
3

Description

The current project lacks detailed documentation, making it challenging for new contributors to understand the structure, set up the development environment, and start contributing effectively.

### Proposed Enhancements

To make the project more open-source friendly, the following improvements are proposed:

- **`README.md`**

- **`.env.example`**
A sample environment variable file to help developers quickly understand and configure the required environment settings.

- ** Docker Configuration**
- **`Dockerfile`** and **`docker-compose.yml`** are added to simplify local development setup with all necessary services (like Postgres, Redis, etc.) included.

- **`CONTRIBUTING.md`**
A contributor guide that outlines the pull request process, coding standards, testing practices, and overall contribution flow.

Contributor guide

No contributing guide indexed for this repository

Research direction

Audit the requested README.md, .env.example, Dockerfile, docker-compose.yml, and CONTRIBUTING.md files against the repository structure and development setup. Start by reviewing the existing project layout and configuration, then document contributor setup, required environment variables, local services, testing practices, and pull request guidance; done means a new contributor can set up and understand the contribution flow.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose, postgresql, python, redis
Domain
databases, devops, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.