Conversation
README.md
Outdated
There was a problem hiding this comment.
This could be misread as "(New-XKit Bot is the team behind New XKit)'s helping little assistant" rather than "New-XKit Bot is (the team behind New XKit)'s helping little assistant". For clarity, I would rewrite this as
New-XKit Bot is New XKit team's little assistant
Wolvan
force-pushed
the
rewrite_1
branch
2 times, most recently
from
3a06d01 to
3598bab
Compare
|
Made your changes top the README.md, @bvtsang |
README.md
Outdated
There was a problem hiding this comment.
GitHub's Markdown Basics document recommends using single backticks (`).
|
The lack of in-line documentation makes things a little tricky to understand what's going on, particularly in the cases where RegEx is being used to transform the messages. I would also still like to see thorough documentation as to how the NewXKit bot is set up and run on our infrastructure. It doesn't necessarily need to be a part of this project, but formal deployment instructions would be helpful. Generally, having monolithic do-everything files make it more difficult to reason about a project. Splitting the code up by concerns and making things more modular would go a long way to help readability and understanding. These have just been my initial thoughts and comments, and do not constitute a formal code review. |
README.md
Outdated
There was a problem hiding this comment.
I think we standardized on New XKit in prose and new-xkit in code, fyi.
|
would be nice to have this linted |
Since this is a rewrite from scratch, clear out everything and restore a clean workspace
After clearing out the old code, re-init the repository with a proper README.md, a LICENSE.md (GPL-2.0) and a .gitignore for NodeJS projects
4 participants
I decided to do a full rewrite of the bot, in turn cleaning it up and making it easier to use and to configure