Setting Up Codecov Environment (Documentation Update)

[duplixx]

What kind of change does this PR introduce?

Issue Number: #1095

Fixes #

Did you add tests for your changes?

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?

[github-actions]

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

[palisadoes]

1. Please upload the images to the repo and reference them there so that we can be assured they will always be available. There are many examples of how to do this in the markdown files.
2. Your current source doesn't meet this requirement

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (655b6b3) 92.77% compared to head (855ca02) 93.54%.
Report is 7 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1112      +/-   ##
===========================================
+ Coverage    92.77%   93.54%   +0.77%     
===========================================
  Files          134      138       +4     
  Lines         3238     3285      +47     
  Branches       904      913       +9     
===========================================
+ Hits          3004     3073      +69     
+ Misses         225      205      -20     
+ Partials         9        7       -2     

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

[palisadoes]

1. For my edification, what is the difference between the public/ directory and the src/assets directory? They seem to have the same type of content.
2. We have this issue created to try to standardize the locations of images for markdowns. I want to make sure that both repos have the same understanding of the purpose. @zakhaev26 is working on it.
   • Standardize the location of repository assets talawa-api#1441 (comment)

[palisadoes]

1. For my edification, what is the difference between the public/ directory and the src/assets directory? They seem to have the same type of content.

   2. We have this issue created to try to standardize the locations of images for markdowns. I want to make sure that both repos have the same understanding of the purpose. @zakhaev26 is working on it.

      • Standardize the location of repository assets talawa-api#1441 (comment)

@duplixx Please respond it is important for a PR submitted by @zakhaev26

[zakhaev26]

@palisadoes imo,given that static assets are being used in Markdown files , to be specific : CONTRIBUTING.md and INSTALLATION.md of Talawa-API , in that case we should proceed with public directory as it offers various benefits like direct access to assets in the web server ,simplifies referencing them in Markdown files.Also by convention /public is more commonly used.

[duplixx]

1. For my edification, what is the difference between the public/ directory and the src/assets directory? They seem to have the same type of content.

   2. We have this issue created to try to standardize the locations of images for markdowns. I want to make sure that both repos have the same understanding of the purpose. @zakhaev26 is working on it.

      • Standardize the location of repository assets talawa-api#1441 (comment)

@duplixx Please respond it is important for a PR submitted by @zakhaev26

@zakhaev26
I agree with your point. Using the "public" directory for static assets in Markdown files, like CONTRIBUTING.md and INSTALLATION.md of Talawa-API, makes perfect sense. The benefits of direct access to assets on the web server and simplified referencing in Markdown files, coupled with the convention of "/public" being more commonly used. Let's proceed with the "public" directory for enhanced accessibility and ease of use.

[palisadoes]

OK. Please update the PR with public/ as the top most directory

[zakhaev26]

Okay,will do that.
Should we do this change across all the Talawa repos ?

For instance, Talawa-Admin has src/assets convention.
Talawa has assets
Talawa Docs has static

[palisadoes]

1. Yes eventually.
2. The exception would be Talawa-Docs uses Docusaurus. It's all Markdown and we used the default location for the images. The root directory markdown files have no images.

[duplixx]

@palisadoes @aashimawadhwa @rishav-jha-mech can it be merged now ??