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(contrib): Add instructions on how to test changes #10221

Merged
merged 4 commits into from
Sep 10, 2024

Conversation

lucasssvaz
Copy link
Collaborator

@lucasssvaz lucasssvaz commented Aug 22, 2024

Description of Change

Add instructions on how to create and run tests.
Fix formatting.

Tests scenarios

Built locally

Related links

Closes #10185

@lucasssvaz lucasssvaz added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Aug 22, 2024
@lucasssvaz lucasssvaz self-assigned this Aug 22, 2024
Copy link
Contributor

github-actions bot commented Aug 22, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Fix typo":
    • summary looks empty
    • type/action looks empty
  • the commit message "Remove manual hooks as they do not exist anymore in the repo":
    • summary looks empty
    • type/action looks empty
  • the commit message "fix(path): Fix file path":
    • summary looks too short

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

Messages
📖 You might consider squashing your 4 commits (simplifying branch history).

👋 Hello lucasssvaz, we appreciate your contribution to this project!


Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against f1399b1

@lucasssvaz
Copy link
Collaborator Author

@Jason2866 @mathieucarbou PTAL.
Any feedback is welcome

@mathieucarbou
Copy link
Contributor

@Jason2866 @mathieucarbou PTAL. Any feedback is welcome

Thank you I will go though the doc when I will be back from vacation and try it for my PR #10186

@Jason2866
Copy link
Collaborator

Thank you. Exactly what i wanted to know. Will try some ;-) Feedback follows. Will need some days ;-)

@VojtechBartoska
Copy link
Collaborator

looks really nice @lucasssvaz!

Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

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

LGTM

@VojtechBartoska VojtechBartoska added Status: Review needed Issue or PR is awaiting review Status: Community help needed Issue need help from any member from the Community. labels Aug 26, 2024
Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

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

LGTM

@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review Status: Community help needed Issue need help from any member from the Community. labels Sep 6, 2024
@me-no-dev me-no-dev merged commit ef23d52 into espressif:master Sep 10, 2024
8 checks passed
@lucasssvaz lucasssvaz deleted the docs/testing branch September 16, 2024 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add developer contributor guidelines to build and test our PR locally
7 participants