You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Understanding the Rocket.Chat codebase, being a large and complex project, is a significant challenge for new contributors. It can be difficult to figure out which folders or files to explore when trying to tackle an issue. This complexity makes the onboarding process slower and more frustrating for contributors.
Describe the solution you'd like
I propose adding a new section to the Developer Docs website dedicated to a "Code Tour." If adding it directly to the website(https://developer.rocket.chat) is not feasible, we could create a Tours.md file in the repository.
The proposed documentation will:
Provide an overview of the project structure, highlighting key directories and files.
Include interactive guidance using tools like the CodeTour VS Code extension to visually map out the codebase.
Make it easier for contributors to navigate the project efficiently and contribute effectively.
Describe alternatives you've considered
If adding it directly to the website is not feasible, we could create a Tours.md file in the repository.
Creating an external guide (e.g., a GitHub Wiki), but this would fragment the information and is harder to maintain.
Relying on live mentoring or issue-based guidance, but this is not scalable and depends on the availability of maintainers or experienced contributors.
Additional context
I was inspired by the GSoC CodeTour project, which demonstrated how effective code tours are for understanding complex codebases. By introducing a Tours.md file or adding a section on the Developer Docs website, we can improve the experience for contributors and onboard new developers faster.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
Understanding the Rocket.Chat codebase, being a large and complex project, is a significant challenge for new contributors. It can be difficult to figure out which folders or files to explore when trying to tackle an issue. This complexity makes the onboarding process slower and more frustrating for contributors.
Describe the solution you'd like
I propose adding a new section to the Developer Docs website dedicated to a "Code Tour." If adding it directly to the website(https://developer.rocket.chat) is not feasible, we could create a Tours.md file in the repository.
The proposed documentation will:
Provide an overview of the project structure, highlighting key directories and files.
Include interactive guidance using tools like the CodeTour VS Code extension to visually map out the codebase.
Make it easier for contributors to navigate the project efficiently and contribute effectively.
Describe alternatives you've considered
If adding it directly to the website is not feasible, we could create a Tours.md file in the repository.
Creating an external guide (e.g., a GitHub Wiki), but this would fragment the information and is harder to maintain.
Relying on live mentoring or issue-based guidance, but this is not scalable and depends on the availability of maintainers or experienced contributors.
Additional context
I was inspired by the GSoC CodeTour project, which demonstrated how effective code tours are for understanding complex codebases. By introducing a Tours.md file or adding a section on the Developer Docs website, we can improve the experience for contributors and onboard new developers faster.
The text was updated successfully, but these errors were encountered: