search

input-output-hk / dapps-certification-web

Certification as a service for the Cardano dApps platform
Apache License 2.0
5 stars 0 forks source link

ci: Added a PR template for contributions to the repository - PLT-9507 #71

Closed RSoulatIOHK closed 6 months ago

RSoulatIOHK commented 6 months ago

Added a template for Pull Request with Checklist to ensure a smoother process and outside contributions.

Ref: PLT-9507

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

[!WARNING]

Rate Limit Exceeded

@RSoulatIOHK has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 47 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 7306baa4ae05c32fdbad87240e96830fe20a2bb9 and e81120ff778cdd9dc99c64639af865126f81ae7a.

Walkthrough

The introduction of a pull request template within the project's .github directory standardizes the submission process for new pull requests. This template ensures that all submissions are consistent, providing sections for a detailed description, a checklist for contributors to follow, and a way to link related issues, enhancing the project's organization and efficiency.

Changes

File(s) Change Summary
.github/pull_request_template.md Added a standardized template for creating pull requests.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
github-actions[bot] commented 6 months ago

Coverage Report

Summary

Lines Statements Branches Functions
Coverage: 4%
 4.92% (115/2333) 1.12% (15/1338) 3.23% (16/494)

JUnit

Tests Skipped Failures Errors Time
5 0 :zzz: 0 :x: 0 :fire: 14.057s :stopwatch:
Coverage (4%)
File% Stmts% Branch% Funcs% LinesUncovered Line #s
All files4.921.123.234.47 
src010000 
   index.tsx0100002–78
src/app0000 
   App.tsx00001–136
src/components/Avatar0000 
   index.tsx00001–33
src/components/CertificationMetadataForm0000 
   index.tsx00001–177
src/components/CertificationMetadataForm/components0000 
   AuditReportForm.tsx0100003–66
   FeedbackModal.tsx00003–44
   ReportScriptForm.tsx00001–158
   ReportScriptFormConfirmModal.tsx0100003–31
src/components/CreateCertificate0000 
   CreateCertificate.tsx00001–196
src/components/CustomSwitch0000 
   CustomSwitch.tsx00001–53
src/components/LogsView0000 
   LogsView.tsx00001–107
   LogsViewEntry.tsx0100001–15
src/components/PaymentConfirmation0000 
   PaymentDetailsVerification.tsx00002–71
src/components/ProgressCard0000 
   CircularProgressBar.tsx00001–40
   ProgressCard.tsx00001–44
src/components/ReconnectWallet010000 
   ReconnectWallet.tsx0100001–31
src/components/RepoAccessStatus0000 
   RepoAccessStatus.tsx00002–28
src/components/Snackbar0000 
   index.tsx00001–56
src/components/StatusIcon0000 
   StatusIcon.tsx00004–18
src/components/Table0000 
   Table.tsx00001–216
src/components/Table/components/ColViz0000 
   ColViz.tsx00001–112
src/components/charts/PieChart0000 
   PieChart.tsx00002–32
src/compositions/InputGroup0000 
   index.tsx00003–35
src/compositions/InputGroup/components0000 
   Container.tsx00003–19
   Input.tsx00003–59
src/compositions/Timeline010000 
   Timeline.tsx0100003–23
src/compositions/Timeline/components/TimelineItem12.38009.41 
   TimelineItem.tsx00003–70
   timeline.helper.tsx16.040011.7620, 32, 36–57, 64–74, 79–142
src/pages/certification21.950016.16 
   Certification.helper.tsx27.830020.5195–100, 104–112, 116–128, 135, 145, 149–150, 154, 158–162, 167–168, 173–174, 183–227
   Certification.tsx00002–81
src/pages/certification/certification-result0000 
   CertificationResult.tsx00001–153
   FullReportTable.tsx00001–61
   fullReportTable.helper.tsx00001–126
src/pages/certification/components0000 
   FailedStatus.tsx00001–41
   FileCoverageContainer.tsx00002–96
   ResultContainer.tsx00002–114
   SuccessCard.tsx00001–89
   UnitTestFailureCard.tsx00001–35
src/pages/certification/components/AuditorRunTestForm0000 
   AuditorRunTestForm.tsx00001–312
src/pages/certification/components/DownloadResult010000 
   DownloadResult.tsx0100001–20
src/pages/certification/components/TimelineView0000 
   TimelineView.tsx00001–235
src/pages/home0000 
   index.tsx00001–195
src/pages/landing0000 
   index.tsx00001–82
src/pages/landing/components48.3819.3546.4247.95 
   ConnectSection.tsx76505073.6846, 70–71, 75–76, 80, 85–94, 125–129
   RegisterModal.tsx00003–43
   RegisterSection.tsx00001–160
   SubscriptionSection.tsx100100100100 
src/pages/metrics0000 
   index.tsx00001–112
src/pages/metrics/components0000 
   AuditorReportsChart.tsx00002–73
   MetricWidget.tsx0100003–37
   RunTimesChart.tsx00002–78
   SubscriptionsChart.tsx0100002–59
src/pages/profile0000 
   index.tsx00001–103
src/pages/reportUpload010000 
   index.tsx0100003–19
src/pages/session0000 
   index.tsx00001–54
src/pages/session/components0000 
   AppBar.tsx00001–86
   AppLayout.tsx00002–44
   NavBar.tsx00002–115
src/pages/support-commands0000 
   config.tsx010010001–72
   index.tsx00001–177
src/pages/support-commands/components0000 
   Card.tsx00001–32
   DeleteUserModal.tsx0100003–60
   UserDetailsModal.tsx00001–112
src/pages/support-commands/details0000 
   index.tsx00001–200
src/pages/testingHistory010000 
   index.tsx0100001–37
src/pages/testingHistory/components0000 
   AppTable.tsx00001–269
   HistoryContainer.tsx00001–64
src/utils10060100100 
   test-utils.tsx1006010010020–22
KJES4 commented 6 months ago

  1. What would be the difference between a link to the issue and the link to the Jira ticket? We may also want to pause accepting this PR till after the group discussion about whether or not we keep using Jira moving forward. The content in this template will have to change depending on the outcome of that call.

    • Include a link to the issue that is fixed.
    • Include a reference to the Jira ticket(s) that have been worked on.

  2. If we plan to keep using Jira and smart commits then the commit messages cannot be more than once sentence long.

  3. I think when we go public we can have both branches but for now we are just using one.

    • [ ] PR targets master/develop

Other than those three points I think everything looks great!