search

moja-global / community-website

Community Website of moja global
https://community.moja.global/
Mozilla Public License 2.0
101 stars 180 forks source link

Documentation: Add project structure to README.md #430

Closed BhaswatiRoy closed 1 year ago

BhaswatiRoy commented 1 year ago

What is the current documentation state?

There is no project structure in the current README.md file

Where is this stated?

README.md file of the repository

Why do you want to improve the statement?

The readme of this repository can include a detailed project structure like the following -

image

Proposed Statement

What needs to be included -

  1. Folders and files contained in each folder
  2. Comments giving a briefing about the functioning and workings of each folder
  3. Detailed overall view of the entire project

Additional context.

Advantages -

  1. Gives an edge to first-time contributors to understand what each section contains
  2. Avoids linear searching time for required files
  3. Makes the contribution process easier
github-actions[bot] commented 1 year ago

Hello there BhaswatiRoy 👋

Welcome to moja global!💖

Thank you and congratulations 🎉 for opening your very first issue in this project. Moja global fosters an open and welcoming environment for all our contributors.🌸 Please adhere to our Code Of Conduct.

Incase you want to claim this issue, please comment down below! We will try to get back to you as soon as we can.👀

Feel free to join us on moja global Slack by dropping an email here.👩‍💻 We would love to hear your interesting ideas and engage in discussions.💖

BhaswatiRoy commented 1 year ago

I would like to work on this!

github-actions[bot] commented 1 year ago

This issue has not seen any activity for the past 30 days. If this Issue would not see any further updates in the next 7 days, it would be automatically closed. Please comment on the issue if you would like to discuss on this further.

github-actions[bot] commented 1 year ago

Thanks for raising an issue! We at moja global appreciate your concerns and views to help us improve. We capitalize on fostering a welcoming environment for all our contributors. This issue was closed because it has been stalled for 7 days with no activity. If you would like to discuss it further, please create another issue or reach out to a maintainer on the prospects of getting it resolved.