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: added one more step for limited-tests to contributor guidelines #34683

Merged
merged 1 commit into from
Jul 5, 2024

Conversation

ApekshaBhosale
Copy link
Contributor

@ApekshaBhosale ApekshaBhosale commented Jul 3, 2024

Description

As we are have been seeing contributors are adding new cypress tests we want to execute it using ci-test-limit. We need to always make a change to limited-tests file to run new test now we will trigger ci-test-limit directly to save efforts.

Fyi: we need to revert limited-tests.txt after everything looks good on PR. this step to reduce one step effort from our side

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.Sanity"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9804245011
Commit: 8384096
Cypress dashboard.
Tags: @tag.Sanity


Fri, 05 Jul 2024 07:03:52 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Copy link
Contributor

coderabbitai bot commented Jul 3, 2024

Walkthrough

The update in CodeContributionsGuidelines.md revises the contribution guidelines for an open-source project. It mainly focuses on reordering steps and adding instructions for creating pull requests, writing tests, and collaborating with maintainers. A significant addition is the requirement to include new Cypress tests in limited-tests.txt, ensuring comprehensive testing for contributions.

Changes

File Path Change Summary
contributions/CodeContributionsGuidelines.md Reordered and added steps for creating pull requests, adding tests, and interacting with maintainers. Included a new instruction for adding Cypress tests to limited-tests.txt. Renumbered subsequent steps.

Poem

In the world of code where bugs might stray,
Contributions guide the way.
Cypress tests to keep them tight,
Maintainers' interactions, a coder's delight.
Pull requests rise, contributions gleam,
In this open-source dream. 🚀🐇

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


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
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 <commit_id>.
    • Generate unit testing code 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 testing code 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 testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Jul 3, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (4)
contributions/CodeContributionsGuidelines.md (4)

25-25: Add a comma before "or".

Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).

- 2. Branches are named as `fix/fix-name` or `feature/feature-name`
+ 2. Branches are named as `fix/fix-name`, or `feature/feature-name`
Tools
LanguageTool

[uncategorized] ~25-~25: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ... 2. Branches are named as fix/fix-name or feature/feature-name 3. Please add te...

(COMMA_COMPOUND_SENTENCE_3)


26-26: Add a comma after "tests".

Possible missing comma found.

- Client-side changes require Cypress/Jest tests while server-side changes require JUnit tests.
+ Client-side changes require Cypress/Jest tests, while server-side changes require JUnit tests.
Tools
LanguageTool

[uncategorized] ~26-~26: Possible missing comma found.
Context: ...lient-side changes require Cypress/Jest tests while server-side changes require JUnit...

(AI_HYDRA_LEO_MISSING_COMMA)


32-32: Remove trailing space.

Trailing spaces are not allowed.

- 9. If changes are requested, work on them, commit them back, and tag the reviewer again. 
+ 9. If changes are requested, work on them, commit them back, and tag the reviewer again.
Tools
Markdownlint

32-32: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


33-33: Remove trailing space.

Trailing spaces are not allowed.

- 10. Once all changes have been approved by the reviewer and the CI has run successfully, your PR will be merged into the base branch. Congratulations! 
+ 10. Once all changes have been approved by the reviewer and the CI has run successfully, your PR will be merged into the base branch. Congratulations!
Tools
Markdownlint

33-33: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8508161 and 8384096.

Files selected for processing (1)
  • contributions/CodeContributionsGuidelines.md (1 hunks)
Additional context used
Path-based instructions (1)
contributions/CodeContributionsGuidelines.md (1)

Pattern **/*.*: Do not use cy.wait in code.
Do call the add function.
Do not keep duplicate lines in code.
Descriptive test names are used to clearly convey the intent of each test.

LanguageTool
contributions/CodeContributionsGuidelines.md

[uncategorized] ~25-~25: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ... 2. Branches are named as fix/fix-name or feature/feature-name 3. Please add te...

(COMMA_COMPOUND_SENTENCE_3)


[uncategorized] ~26-~26: Possible missing comma found.
Context: ...lient-side changes require Cypress/Jest tests while server-side changes require JUnit...

(AI_HYDRA_LEO_MISSING_COMMA)

Markdownlint
contributions/CodeContributionsGuidelines.md

32-32: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


33-33: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

Additional comments not posted (7)
contributions/CodeContributionsGuidelines.md (7)

27-27: LGTM!

The new step to add Cypress test paths to limited-tests.txt is a valuable addition to ensure proper tracking of tests.


28-28: LGTM!

The renumbering of the step for creating a pull request is logical and maintains the flow of instructions.


29-29: LGTM!

The renumbering of the step for calling out API changes in the pull request is logical and maintains the flow of instructions.


30-30: LGTM!

The renumbering of the step for linking the issue in the pull request is logical and maintains the flow of instructions.


31-31: LGTM!

The renumbering of the step for tagging the maintainer to start the build process is logical and maintains the flow of instructions.


32-32: LGTM!

The renumbering of the step for working on requested changes is logical and maintains the flow of instructions.

Tools
Markdownlint

32-32: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


33-33: LGTM!

The renumbering of the step for merging the pull request after approval is logical and maintains the flow of instructions.

Tools
Markdownlint

33-33: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

@ApekshaBhosale ApekshaBhosale added the ok-to-test Required label for CI label Jul 5, 2024
Copy link
Contributor

@somangshu somangshu left a comment

Choose a reason for hiding this comment

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

LGTM

@somangshu somangshu merged commit 5729d08 into release Jul 5, 2024
48 checks passed
@somangshu somangshu deleted the guideline-limited-tests branch July 5, 2024 08:49
Shivam-z pushed a commit to Shivam-z/appsmith that referenced this pull request Jul 10, 2024
appsmithorg#34683)

## Description

As we are have been seeing contributors are adding new cypress tests we
want to execute it using `ci-test-limit`. We need to always make a
change to limited-tests file to run new test now we will trigger
`ci-test-limit` directly to save efforts.
 
Fyi: we need to revert `limited-tests.txt` after everything looks good
on PR. this step to reduce one step effort from our side


Fixes #`Issue Number`  
_or_  
Fixes `Issue URL`
> [!WARNING]  
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._

## Automation

/ok-to-test tags="@tag.Sanity"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/9804245011>
> Commit: 8384096
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9804245011&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity`
> <hr>Fri, 05 Jul 2024 07:03:52 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No
This was referenced Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants