CONTRIBUTING.md

Contributing Guide

Thank you for considering contributing to the Dale Study Group Website! We appreciate your time and effort. Here are some guidelines to help you get started.

Table of Contents

• Contributing Guide
  • Table of Contents
  • How to Contribute
  • Style Guides
    • Coding Standards
    • Commit Messages
  • Community

How to Contribute

We manage our project using GitHub Projects. You can find the project here. The team holds a weekly meeting to discuss the previous week's progress and plan for the upcoming week.

1. Create ticket(item or draft in Backlog)s together in regular meetings.
2. Assign yourself to a ticket on the Kanban board.
3. Convert item to an Issue with click "Convert to issue" button.
4. Create a branch through the Issue.
5. Make a PR after you've pushed your code changes (Don't forget to link your PR to the Issue you created earlier).
6. After a code review and receiving at least one approval, merge the changes into the main branch.
7. The code merged into the main branch will be immediately released through GitHub Pages.

Style Guides

Coding Standards

• Follow the coding style conventions of the project.
• Use the default settings of Prettier.
• For web component writing patterns, refer to this document.

Commit Messages

• Use clear and descriptive commit messages.
• Follow the Conventional Commits specification.

Community

• Join our Discord to connect with other contributors.