Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Guided Documentation for RC codebase (Develop) #30188

Open
wants to merge 60 commits into
base: develop
Choose a base branch
from

Conversation

AdityaSingh-02
Copy link
Contributor

Proposed changes (including videos or screenshots)

todo- merge in develop, #29623 doesn't work with latest latest branch

Know more about project here

  • Set of 9 essential tours which is enough to make any contributor or developer familiar with codebase

Tours Available

S no. Tour
1 Repository Overview
2 How to send a message (Client Side)
3 How to send a message (Server Side)
4 How to create an endpoint
5 How to create a DB model
6 How to use DB model
7 Services in Rocket.Chat
8 How to Add a new Services
9 How to create a new Package

Issue(s)

GSOC-2023 project - Guided RC tours and Code walkthrough

Steps to test or reproduce

  • Install CodeTour extension in VS code
  • ctrl+shift+p or cmd+shift+p to open all commands and then select CodeTour : Start Tour

Further comments

  • All changes are in JSON format, You would require a CodeTour extension to use it.

How it works and where would it get merged?

It would not create any merge conflict or code break, It would get merged into main codebase with a new folder .tours which would not break the code

rc

AdityaSingh-02 and others added 30 commits May 30, 2023 10:59
AdityaSingh-02 and others added 23 commits July 23, 2023 19:32
@changeset-bot
Copy link

changeset-bot bot commented Aug 27, 2023

⚠️ No Changeset found

Latest commit: 81b3b6b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

codecov bot commented Jan 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.25%. Comparing base (68f541c) to head (81b3b6b).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop   #30188      +/-   ##
===========================================
- Coverage    54.69%   54.25%   -0.45%     
===========================================
  Files         2299     2248      -51     
  Lines        50742    49833     -909     
  Branches     10375    10117     -258     
===========================================
- Hits         27754    27035     -719     
+ Misses       20497    20343     -154     
+ Partials      2491     2455      -36     
Flag Coverage Δ
e2e 52.84% <ø> (-0.89%) ⬇️
e2e-api 40.04% <ø> (+0.05%) ⬆️
unit 75.80% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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