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 #29623

Draft
wants to merge 66 commits into
base: develop
Choose a base branch
from

Conversation

AdityaSingh-02
Copy link
Contributor

@AdityaSingh-02 AdityaSingh-02 commented Jun 22, 2023

Proposed changes (including videos or screenshots)

Todo: merge with 6.3.2 and not in develop

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

@changeset-bot
Copy link

changeset-bot bot commented Jun 22, 2023

⚠️ No Changeset found

Latest commit: 4c54507

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

@KevLehman KevLehman changed the title Guided Tour Test 1 chore: Guided Documentation for RC codebase Jun 22, 2023
@KevLehman KevLehman self-assigned this Jun 22, 2023
@KevLehman KevLehman marked this pull request as draft June 22, 2023 15:14
@codecov
Copy link

codecov bot commented Jun 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.18%. Comparing base (169da3a) to head (4c54507).
Report is 2120 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop   #29623      +/-   ##
===========================================
- Coverage    51.29%   51.18%   -0.12%     
===========================================
  Files          811      805       -6     
  Lines        15059    15074      +15     
  Branches      2751     2785      +34     
===========================================
- Hits          7725     7716       -9     
  Misses        6926     6926              
- Partials       408      432      +24     
Flag Coverage Δ
e2e 48.50% <ø> (-0.07%) ⬇️
unit 64.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
Projects
None yet
Development

Successfully merging this pull request may close these issues.