RealDevSquad / RealDevSquad/website-backend

RFC - Task log structure

Open
#733 2 comments 0 reactions 1 assignee View on GitHub

@ivinayakg is already working on this.

Since Oct 29, 2022.

  • #725 by @ivinayakg — merged
Dominant language
JavaScript
Stars
74
Forks
276
Avg merge
1d 26m
Merged PRs (30d)
14

Description

Doubt for - #725 [RESOLVED but still open for discussion]

Log Model RFC - #49

The basic log structure is as follows

type - Categorises the type of log.
timestamp - Time and date of the log creation.
meta - Object-containing fields that usually are common across different types of logs.
body - Object containing data with respect to the type of the log.

Approach for Task Log

Assuming status and percentCompleted are changed by the user.
  •  type : 'task',
     meta : {
        taskId,
        username,
        userId
     }
     timestamp,
     body : {
       subType : CREATE | UPDATE | DELETE
       new : {
           status, 
           percentCompleted,
           //many more...
        }
     }

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.