search

HasithDeAlwis / Hasith-Portfolio-v2

Version two of my portfolio
0 stars 0 forks source link

[TASK] Update README and setup issue templates, PR templates, and LEARNINGS.MD #5

Closed HasithDeAlwis closed 3 months ago

HasithDeAlwis commented 3 months ago

Problem Statement Currently the README is the generic Astro README, this doesn't give any new GitHub users any idea of what it is I'm making. Additionally, making PRs and issues at the moment can be confusing and the structure is not defined. Templates are needed so that contributors can easily make issues and PRs without decision fatigue.

Goals

  1. Update README
  2. Add Figma to README
  3. Issue templates (bug, feature, ADR, generic)
  4. PR tempaltes
  5. Start writing the LEARNINGS.MD

Out of Scope

  1. Contributing guideline
    • At the moment I'm still not sure of how someone can accurately contribute to this project, more research is needed on best practices to make an up to date and solid contribution guideline