GaryHilares / GaryHilares/ContribMatch-server

[User story] Add content to README.md

Open
#10 0 comments 0 reactions 1 assignee Claimed by @GaryHilares View on GitHub
enhancement good first issue
Dominant language
TypeScript
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Description
As a potential ContribMatch API developer or ContribMatch-API-based app developer, I would like to know what the project is about, so that I can determine if it fits my needs and/or whether I would like to contribute to it.

## Acceptance criteria
- Upon opening the repo on GitHub, developers **must** be able to see a description of the following: what ContribMatch is, what it tries to solve, and how ContribMatch-server fits in the picture.
- Upon opening the repo on GitHub, developers **should** be able to see a description including the following: The project's code of conduct, the name of the license of the repository with a link to it, and contributing guidelines or a link to them.
- Upon opening the repo on GitHub, developers **could** be able to see a description including the following: Security policy, or a link to it.

## Engineering tasks
- Set up the README.md and associated files.

## Time estimates
- **Story points:** 2.
- **Deadline:** 2025-05-23.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.