Skip to content

Latest commit

 

History

History
17 lines (16 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

17 lines (16 loc) · 1.15 KB
Raw

Contributing guidelines

Basic workflow

  1. Pick a task/bug from the project board's To Do list. Assign the task to yourself.
  2. Create a new local Git branch named task/task-name or bug/bug-name. Usually you'll want master as a base branch.
git checkout -b task/task-name
  1. Implement a functionality. Keep in mind:
    • Commits
      • Short, understandable description: "add validation in XYZ", "refactor ABC class", "fix: Search button in responsive mode" etc. If you feel the commit description is too long (more than 60~70 characters), consider splitting your changes into multiple commits.
    • Tests: we want more of these. Tests (kind of) enforce good design principles, such as SOLID. An untestable code is often a bad code.
    • Static analysis: Visual Studio and Resharper for C#; Vue and TypeScript-related VS Code plugins for the frontend.
  2. Once a feature is implemented, ensure that all changes have been pushed to GitHub.
  3. Open a Pull Request and assign another team member to a Reviewer role.
  4. Resolve Code Review comments should any appear.
  5. Once the Pull Request is approved, merge the Pull Request.