@dmpellegrini, when merging new files into the repository, it's important to provide a clear and concise description of what the files contain and what concepts they reinforce (e.g. recursions).
Clear commit messages for updates to existing files are fine
In addition, the code should be thoroughly commented to explain its functionality and purpose, or there should be an accompanying markdown file that accomplishes the same. This way, other developers can understand the logic behind the code and follow along more easily.
Furthermore, for files that accept inputs and have expected outputs, it's recommended to include an associated Jest file for testing purposes (Or at least a detailed description of how the code works and examples of expected inputs and outputs via in-code commentary or in the description). You can find an example of the following directory -
@dmpellegrini, when merging new files into the repository, it's important to provide a clear and concise description of what the files contain and what concepts they reinforce (e.g. recursions).
Clear commit messages for updates to existing files are fine
In addition, the code should be thoroughly commented to explain its functionality and purpose, or there should be an accompanying markdown file that accomplishes the same. This way, other developers can understand the logic behind the code and follow along more easily.
Furthermore, for files that accept inputs and have expected outputs, it's recommended to include an associated Jest file for testing purposes (Or at least a detailed description of how the code works and examples of expected inputs and outputs via in-code commentary or in the description). You can find an example of the following directory -
You can access the example Jest file Sample Jest File and Structure.