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

docs: added typescript installation guide in INSTALLATION.md #1251

Merged
merged 4 commits into from
Dec 29, 2023

Conversation

MahendraDani
Copy link
Contributor

What kind of change does this PR introduce?
docs

Issue Number:

Fixes #1243

Did you add tests for your changes?
No

Snapshots/Videos:
NA

If relevant, did you update the documentation?

Summary

  1. Added typescript installation section in INSTALLATION.md
  2. Updated table of content in the file.

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?

Copy link

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link

codecov bot commented Dec 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a7e4663) 96.30% compared to head (0646b11) 96.30%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1251   +/-   ##
========================================
  Coverage    96.30%   96.30%           
========================================
  Files          137      137           
  Lines         3387     3387           
  Branches       949      949           
========================================
  Hits          3262     3262           
  Misses         119      119           
  Partials         6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@palisadoes
Copy link
Contributor

Please look at the more comprehensive documentation for Talawa-API that explains how to install node and make the appropriate changes at the appropriate locations

@MahendraDani
Copy link
Contributor Author

Please look at the more comprehensive documentation for Talawa-API that explains how to install node and make the appropriate changes at the appropriate locations

@palisadoes I have following two doubts:

  1. Should I update the current Nodejs setup guide as given in https://github.com/PalisadoesFoundation/talawa-api/blob/develop/INSTALLATION.md#install-nodejs ?
  2. Is the setup guide for typescript written by me appropriate or it requires changes?

Thanks

@palisadoes
Copy link
Contributor

palisadoes commented Dec 23, 2023

Use what we have in the API guide as inspiration in the Admin guide

The Admin guide does not recommend node package managers to use. We need the same here for consistency

@MahendraDani
Copy link
Contributor Author

I will do the necessary changes and update the PR by tomorrow.
Sorry for the delay

@MahendraDani
Copy link
Contributor Author

MahendraDani commented Dec 27, 2023

@palisadoes I have updated the docs. I have referred to installation guide for nodejs as provided in https://github.com/PalisadoesFoundation/talawa-api/blob/main/INSTALLATION.md.

If there are any changes please let me know.
Thanks

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment

INSTALLATION.md Show resolved Hide resolved
@MahendraDani
Copy link
Contributor Author

@palisadoes I have made the necessary changes

palisadoes
palisadoes previously approved these changes Dec 28, 2023
@palisadoes
Copy link
Contributor

Please fix the conflicting files

@MahendraDani
Copy link
Contributor Author

@palisadoes I have resolved merge conflicts and updated this branch with develop branch.

@palisadoes palisadoes merged commit 208338d into PalisadoesFoundation:develop Dec 29, 2023
8 checks passed
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