Eddiebot: Add some documentation here for beginners to understand the working of bot.

[Shanmuganathanb]

1) In Features,
We can add the suggestion of bot giving us better words there after.

2)Can ask people to add suggestion of words into the repository. I don't know whether it actually exists or not.

[github-actions[bot]]

It's great having you contribute to this project

Feel free to raise an Issue! Welcome to the community :nerd_face:

If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 🤓 . Any questions let us know.

[BOLT04]

Hi @Shanmuganathanb, thank you for raising this issue 😃. I am going to address your questions in separate.

Add some documentation here for beginners to understand the working of bot

We have currently some documentation on the README of the repository. Is there a specific part you don't understand? This documentation can always be improved, so we appreciate if you can give more details on the part you are having difficulty 😃.

We can add the suggestion of bot giving us better words there after.

Yes, we can add that new feature you mentioned to the list. This was recently added in this PR so we haven't updated the feature list with it. It can be something like:

Features

• Configured words show with alternatives suggestions after the user sends a message
  

_Note: Not sure if we want to add a picture to the features list, but perhaps it's easier to understand with it 🤔 ?_

2)Can ask people to add suggestion of words into the repository. I don't know whether it actually exists or not.

The word suggestions are in config.ts. Any contribution is very welcome and we can review it in a PR 👍.

[stemount]

262 will actually help here if a user does not wish to put this filter on their server, this feature is not production ready yet as well so thanks for raising the issue @Shanmuganathanb and I believe it has been disabled for the time being.

• @Shanmuganathanb as @BOLT04 has triaged above, I do agree the README can be improved, #156 has some suggestions of improvements, assigning that issue to @eddiejaoude to change the deployment variables of the dev bot then we can build on top of that.
• @Shanmuganathanb If you are comfortable checking out PR #156 and creating a pull request with improvements to README.md into this branch after checking out the Docker box and seeing if this makes it easier for you to get involved with this project - this would be really helpful.
  
  
  
  • You can create a PR into feature/add-dotenv and then we can approve changes to this and get the Docker version of running the bot merged in 💯
  
  

[eddiejaoude]

This feature is still currently active, the bot is not appearing that much anymore in the chat because people have learnt to be more inclusive with their wording - so it looks like it is doing what it is meant too 🎉

[github-actions[bot]]

Stale issue message

[mikeysan]

Github actions has a good point. Why is this issue still open?

[BOLT04]

I think we haven't decided what documentation to produce for this issue @mikeysan. The small change is done quickly, which is to add the feature of the word suggestions, on the Features list of the README.

The "how to add a suggestion of words into the repository" requires more thought.

@EddieJaoudeCommunity/coreteam what approach does everyone think is best, closing this issue or making a list of tasks for someone to do and make a PR?

[eddiejaoude]

I think making new issues with specific actions to do would be more useful to people wanting to contributor - I know most ideas/issues start off bigger, but I like the idea of then creating smaller task issues and closing the bigger one (plus more green squares 🟩