Ptidej Team

While contributing to the project, you may encounter issues that you could ask help from colleagues, with that in mind, a tool to create issues automatically in the github PTIDEJ repository was made.

It will parse and generate title, tags, descriptions and semantics automatically in the following order:

1- The first line of comment is always:

“ TODO” 2- To keep same issue after step 1, keep using “” in the next lines Correct:

TODO same issue comment someMethod()

Wrong: TODO someMethod() same issue comment

3- Issues are created by files, so different “ TODO” in same file and SEPARATED by at least ONE LINE REAL OF CODE will be in the same issue but different section. One TODO: TODOx` something TODO something else method(); Two TODO: TODO something method(); TODO something else 4- Inside any TODO, add certain codes in the middle of the comment to create context to the issue reader Example 1: @#ADD_METHOD = Add a method TODO @#ADD_METHOD some_method() Result of example 1: “The method some_method() needs to be added 5- Following are all the ID's for these codes, what they do and how to use respectively: @#ADD_METHOD = Add a method ⇒ `@#ADD_METHOD something_method()` @#REMOVE_METHOD = Remove a method ⇒ `@#REMOVE_METHOD something_method()` @#ADD_CONSTANT = Add a constant ⇒ `@#ADD_CONSTANT SOME_CONSTANT` @#REMOVE_CONSTANT = Remove a constant ⇒ `@#REMOVE_CONSTANT SOME_CONSTANT` @#FIX_BUG / @#END_BUG = Fix a bug ⇒ `@#FIX_BUG description of the bug @#END_BUG` @#IMPROVE_PERFORMANCE / @#END_PERFORMANCE = Improve performance ⇒ `@#IMPROVE_PERFORMANCE description of performance issue @#END_PERFORMANCE` @#REFACTOR_CODE / @#END_REFACTOR = Refactor the code ⇒ `@#REFACTOR_CODE description of what to refactor @#END_REFACTOR` @#UPDATE_DEPENDENCY = Update a dependency ⇒ `@#UPDATE_DEPENDENCY library_name` @#ADD_DOCUMENTATION / @#END_DOCUMENTATION = Add documentation ⇒ `@#ADD_DOCUMENTATION description of what needs documenting` @#REMOVE_DEPRECATED / @#END_DEPRECATED = Remove deprecated code ⇒ `@#REMOVE_DEPRECATED description of deprecated code` @#HANDLE_ERROR / @#END_ERROR = Handle an error case ⇒ `@#HANDLE_ERROR description of error` @#ADD_TEST / @#END_TEST = Add a test case ⇒ `@#ADD_TEST description of test case`