Main readme

[21Bhang]

---

name: General PR template
about: A template with a generic and high-level review checklist, feel free to modify the checklists based on your PR.

General Checks

• the branch is up to date with main
• the code works when pulled and run locally
• All CI checks pass (or at least discussed)
• all conflicts are resolved (if any)
• PR has a descriptive title
• PR has appropriate labels and milestones for easy identification
• PR it is assigned to the owner
• reviewers are assigned
• the PR contributes only one focused change
• It is in the appropriate column in the project board (if necessary)
• has short and clear description
• is linked to an issue (if it is related)
• feedback is addressed (if any and if it is appropriate feedback.)

Markdown

• the markdown source is formatted
• spelling and grammar is correct in all text
• The markdown looks correct when you preview the file
• all links and images work

[21Bhang]

commenting updates