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

Add Info for pioarduino community version #10045

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

Jason2866
Copy link
Collaborator

@Jason2866 Jason2866 commented Jul 18, 2024

Add the info in documentation of the Community version pioarduino and remove the non anymore working info about using the git Arduino master branch with Platformio.

@me-no-dev or the responsible maintainer for the docu

Copy link
Contributor

github-actions bot commented Jul 18, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "'For' instead of 'To'":
    • summary looks empty
    • type/action looks empty
  • the commit message "Add Info for pioarduino community version":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update to core 3.0.4":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update to core 3.0.5":
    • summary looks empty
    • type/action looks empty
  • the commit message "add example Note":
    • summary looks empty
    • type/action looks empty
  • the commit message "move Platformio Info section":
    • summary looks empty
    • type/action looks empty
  • the commit message "pin Pio version and correct github source for Arduino 3.0.x":
    • summary looks empty
    • type/action looks empty
  • the commit message "remove Platformio from community sentence":
    • summary looks empty
    • type/action looks empty
  • the commit message "try to fix styling issues":
    • summary looks empty
    • type/action looks empty

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).

⚠️ Please consider squashing your 9 commits (simplifying branch history).

👋 Hello Jason2866, 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.
- 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 e4f645c

@VojtechBartoska VojtechBartoska added Type: Documentation Issue pertains to Documentation of Arduino ESP32 IDE: PlaformIO Issue relates to PlatformIO IDE labels Jul 18, 2024
@me-no-dev
Copy link
Member

@Jason2866
Copy link
Collaborator Author

GH actions seems to hung. CLA is signed.

@me-no-dev
Copy link
Member

CLA is PITA sometimes. The Pre-commit check is waiting for "Pending Merge" label (we add it once we have agreed it's good to merge)

@me-no-dev me-no-dev added the Status: Review needed Issue or PR is awaiting review label Jul 21, 2024
docs/en/installing.rst Outdated Show resolved Hide resolved
docs/en/installing.rst Outdated Show resolved Hide resolved
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.

I have just a minor change, otherwise, LGTM.

docs/en/installing.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
IDE: PlaformIO Issue relates to PlatformIO IDE Status: Review needed Issue or PR is awaiting review Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants