Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refacto (WF NTP sources): Bring order to Chaos #1 #31

Open
8 tasks
madvid opened this issue Jun 17, 2022 · 0 comments
Open
8 tasks

Refacto (WF NTP sources): Bring order to Chaos #1 #31

madvid opened this issue Jun 17, 2022 · 0 comments
Assignees
@madvid @jhparkkkk @shell02
Labels
documentation Improvements or additions to documentation feature

Comments

@madvid
Copy link
Contributor

madvid commented Jun 17, 2022 •
edited
Loading

User Story

As a dev and an user,
I want to refacto the entire code base of WF NTP because this is a mess (no norm, limited docstring).
so that the code complies with the Lab42AI development guidelines.

The compliance:

  • norm (black, isort, pep8 modules)
  • docstrings is google format (darglint module to check)
  • monolithic code
  • parameters are into json (defaults.py into a json file)
  • unit tests are written

Acceptance Criteria

  • code norm
  • docstrings to every classes and functions
  • monolithic structure
  • unitests
  • setup procedure is detailled (+ if there is a script allowing it)

Definition of Done

  • Product Owner accepts the User Story
  • Acceptance criteria met
  • code is released into a independant directory

Defined by CICD:

  • Code reviewed
  • black compliant
  • Unit tests passed
  • Functional tests passed
  • Non-Functional requirements met
@madvid madvid added back log issue related to a feature, bug or refacto but which is not planed yet feature and removed feature labels Jun 17, 2022
@madvid madvid added documentation Improvements or additions to documentation feature and removed back log issue related to a feature, bug or refacto but which is not planed yet labels Aug 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@madvid madvid

@jhparkkkk jhparkkkk

@shell02 shell02

Labels
documentation Improvements or additions to documentation feature
Projects
None yet
Milestone
No milestone
Development

When branches are created from issues, their pull requests are automatically linked.

31-refacto-wf-ntp-sources-bring-order-to-chaos-1 42-AI/Elegant-Elegans
3 participants
@madvid @jhparkkkk @shell02