From fb3903c55ea42f831831708c280bb99d05e20649 Mon Sep 17 00:00:00 2001 From: Victor Wheeler Date: Mon, 24 Feb 2025 15:24:51 -0700 Subject: [PATCH] docs(bindings): proofread batch 20 (#7764) --- docs/CONTRIBUTING.rst | 133 ++++--- docs/_static/css/custom.css | 24 +- .../details/integration/bindings/api_json.rst | 335 +++++++++--------- .../integration/bindings/javascript.rst | 46 +-- .../integration/bindings/micropython.rst | 151 ++++---- .../integration/bindings/pikascript.rst | 57 +-- 6 files changed, 396 insertions(+), 350 deletions(-) diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index fcc4fb160..8b336f40d 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -1,10 +1,11 @@ .. _contributing: +============ Contributing ============ Introduction ------------- +************ Join LVGL's community and leave your footprint in the library! @@ -15,39 +16,38 @@ It might be scary to make the first step but you have nothing to be afraid of. A friendly and helpful community is waiting for you. Get to know like-minded people and make something great together. -So let's find which contribution option fits you the best and help you +So let's find which contribution option fits you the best and helps you join the development of LVGL! -Ways to contribute -------------------- +Ways to Contribute +****************** - **Spread the Word**: Share your LVGL experience with friends or on social media to boost its visibility. -- **Star LVGL** Give us a star on `GitHub `__ ! It helps a lot to LVGL more appealing for newcomers. -- **Report a bug**: Open a `GitHub Issue `__ if something is not working. -- **Join our** `Forum `__ : Meet fellow developers and discuss questions -- **Tell your ideas**: If you miss something from LVGL we would love to hear about it in a `GitHub Issue `__ -- **Develop features**: Help to design or develop a feature. See below. +- **Star LVGL** Give us a star on `GitHub `__! It helps a lot to make LVGL more appealing for newcomers. +- **Report a Bug**: Open a `GitHub Issue `__ if something is not working. +- **Join Our** `Forum `__ : Meet fellow developers and discuss questions. +- **Tell Us Your Ideas**: If you feel something is missing from LVGL, we would love to hear about it in a `GitHub Issue `__ +- **Develop Features**: Help to design or develop a feature. See below. +Mid- and large-scale issues are discussed in `Feature Planning `__ issues. -Mid and large scale issues are discussed in `Feature planning `__ issues. - -An issue can be developed when all the questions in the issue template are answered and there is no objection from any core member. +An issue can be developed when all the questions in the issue template are answered and there are no objection from any core member. We are using GitHub labels to show the state and attributes of the issues and Pull requests. If you are looking for contribution opportunities you can `Filter for these labels `__ : -- ``Simple``: Good choice to get started with LVGL contribution +- ``Simple``: Good choice to get started with an LVGL contribution - ``PR needed``: We investigated the issue but it still needs to be implemented - ``Review needed``: A Pull request is opened and it needs review/testing -.. _contributing_pull_request: +.. _contributing_pull_requests: -Pull request ------------- +Pull Requests +************* -Merging new code into the lvgl, documentation, blog, examples, and other -repositories happen via *Pull requests* (PR for short). A PR is a +Merging new code into LVGL, documentation, blog, examples, and other +repositories happens via *Pull requests* (PR for short). A PR is a notification like "Hey, I made some updates to your project. Here are the changes, you can add them if you want." To do this you need a copy (called fork) of the original project under your account, make some @@ -57,20 +57,20 @@ https://github.com/lvgl/lvgl/pulls. To add your changes you can edit files online on GitHub and send a new Pull request from there (recommended for small changes) or add the -updates in your favorite editor/IDE and use git to publish the changes +updates in your favorite editor/IDE and use ``git`` to publish the changes (recommended for more complex updates). From GitHub -~~~~~~~~~~~ +----------- 1. Navigate to the file you want to edit. 2. Click the Edit button in the top right-hand corner. 3. Add your changes to the file. -4. Add a commit message on the bottom of the page. +4. Add a commit message at the bottom of the page. 5. Click the *Propose changes* button. -From command line -~~~~~~~~~~~~~~~~~ +From Command Line +----------------- The instructions describe the main ``lvgl`` repository but it works the same way for the other repositories. @@ -79,23 +79,23 @@ same way for the other repositories. "Fork" button in the top right corner. It will "copy" the ``lvgl`` repository to your GitHub account (``https://github.com/?tab=repositories``) 2. Clone your forked repository. -3. Add your changes. You can create a *feature branch* from *master* for the updates: ``git checkout -b `` +3. Add your changes. You can create a *feature branch* from THE ``master`` branch for the updates: ``git checkout -b `` 4. Commit and push your changes to the forked ``lvgl`` repository. 5. Create a PR on GitHub from the page of your ``lvgl`` repository (``https://github.com//lvgl``) by clicking the *"New pull request"* button. Don't forget to select the branch where you added your changes. -6. Set the base branch. It means where you want to merge your update. In the ``lvgl`` repo both the fixes - and new features go to ``master`` branch. -7. Describe what is in the update. An example code is welcome if applicable. +6. Set the base branch where you want to merge your update. In the ``lvgl`` repo both fixes + and new features are directed to the ``master`` branch. +7. Describe what is in the update. Example code is welcome if applicable. 8. If you need to make more changes, just update your forked ``lvgl`` repo with new commits. They will automatically appear in the PR. .. _contributing_commit_message_format: -Commit message format -~~~~~~~~~~~~~~~~~~~~~ +Commit Message Format +--------------------- The commit messages format is inspired by `Angular Commit -Format `__. +Format `__. The following structure should be used: @@ -109,54 +109,70 @@ The following structure should be used: Possible ````\ s: -- ``fix`` bugfix in the source code. +- ``fix`` bugfix in LVGL source code - ``feat`` new feature - ``arch`` architectural changes -- ``perf`` changes that affect the performance -- ``example`` anything related to examples (even fixes and new examples) -- ``docs`` anything related to the documentation (even fixes, formatting, and new pages) +- ``perf`` changes that affect performance +- ``example`` anything related to examples (including fixes and new examples) +- ``docs`` anything related to documentation (including fixes, formatting, and new pages) - ``test`` anything related to tests (new and updated tests or CI actions) - ``chore`` any minor formatting or style changes that would make the changelog noisy -```` is the module, file, or sub-system that is affected by the +```` is the name of the module, file, or subsystem affected by the commit. It's usually one word and can be chosen freely. For example ``img``, ``layout``, ``txt``, ``anim``. The scope can be omitted. ```` contains a short description of the change: -- use the imperative, present tense: "change" not "changed" nor "changes" -- don't capitalize the first letter -- no dot (``.``) at the end -- max 90 characters +- use the imperative, present tense: "change" not "changed" nor "changes", +- don't capitalize the first letter, +- no period (``.``) at the end, +- max 90 characters. -```` optional and can be used to describe the details of this +```` optional and can be used to describe details of the change. ``