Skip to content

Create header for recurrent magic numbers #46

@jcarraror

Description

@jcarraror
  • Motivation: There is a lot of recurrent values in the project, mainly for offsets and structure skipping. The meaning of these values may make sense for us, but for the SDK users, magic number may be confusing and misleading.

  • Objective: Create a proper header to define variable for the recurrent values in the SDK

  • Success Criteria: Using the variables from the header/structure instead of pure values

  • Dependencies: No new external dependencies are expected for this task.

  • Risks and Mitigations: The task involves identifying all the recurrent values that can be consted in a file/structure. It's important to identify only the values that can be consted, if this procedure it's applyied on dynamic values, we will have problems. Rigorous testing and review should be performed to ensure that these changes does not inadvertently introduce nbugs or compromise the existing functionalities.

  • Resource Allocation: This task can be a bit extensive and will touch plenty of source files of the project. It necessitates close attention to detail. This task must not change any functionality of the SDK, that is, the same tests must pass after the changes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions