Skip to content

Conversation

@R0ham
Copy link

@R0ham R0ham commented Aug 21, 2020

Related Issues
What issues or other pull requests are related to this one?
None that I know of.

Describe the Changes
Clearly state what you have changed and why.
Documentation has been significantly enhanced. The 'README.md' file provided great info, but it still wasn't as thorough or consolidated as it could have been. Node packages have also been updated.

Still To Do
Is there anything that is unfinished, and if so what is it and why?
Documentation updates are done, but the purpose of the branch (to implement the text-to-speech feature remains unfinished – there is potential for this to be done in the future as new members take on the implementation task of this feature).

Problems
Are there any problems or caveats with this code?
There are no known problems with this code. The only potential area of error is with the update of the node packages. This had to be done to resolve npm issues during install, however, there is the possibility that this could have broken some aspects of the site which may rely on outdated package features.

Testing
What did you do to test these commits? and how would someone go about testing it themselves?
Unfortunately, little testing was performed to ensure the reliability of the site after the node packages were updated. If that presents an issue with the workings of the site, that commit can be rejected, although the documentation changes are extensive and preferably would be better suited to be on the master branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants