diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 33ea850c5..0e9e2a84f 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -22,8 +22,8 @@ the generic https://opensource.guide/[Open Source Guides] first. Bugs and enhancements are tracked in the https://github.com/robotframework/RIDE/issues[issue tracker]. If you are unsure if something is a bug or is a feature worth -implementing, you can first ask on link:https://forum.robotframework.org/c/tools/ride/21/[RIDE-users] -(#RIDE on irc.freenode.net), or on +implementing, you can first ask on link:https://forum.robotframework.org/c/tools/ride/21/[RIDE] +(RIDE at Forum), or on https://robotframework-slack-invite.herokuapp.com[Slack]. These and other similar forums, not the issue tracker, are also places where to ask general questions. @@ -105,6 +105,33 @@ to create dedicated topic branches for pull requests instead of creating them based on the master branch. This is especially important if you plan to work on multiple pull requests at the same time. +=== RIDE Code Setup + +The basic code setup of RIDE, needs a additional steps since v2.1.1 (November 2024): + +. Forking the project (Web interface) +. Clone (for example) ``git clone git@github.com:robotframework/RIDE.git`` +. ``cd RIDE`` +. `pip install -U -r requirements-dev.txt` +. ``git submodule init`` +. ``git submodule update`` + +Then you may change to the ``develop`` branch, which should be the base for features or fixes branches, and the target for pull requests. Example: + +. ``git checkout develop`` +. ``git submodule init`` +. ``git submodule update`` +. ``git pull origin develop`` +. ``git checkout -b a_new_branch_based_on_develop`` +. After changes, you add new files, ``git add a_new_file`` +. You add and commit the modified files, ``git -a -m "The short message with info about the change`` +. You push the commit to your fork, ``git push origin a_new_branch_based_on_develop`` +. You may repeat the commit/push and when ready create a Pull Request to your ``develop`` branch, or +. You checkout your ``develop``branch, and merge with ``git merge a_new_branch_based_on_develop`` +. Later you should keep the ``develop`` branch updated by pulling from your remote, ``git pull origin develop``, or +. By pushing ``git push origin develop`` +. Finaly, you can create a Pull Request from your fork to the target ``develop`` branch of the original RIDE project. + === Coding conventions NOTE: RIDE graphical user interface, can only exist due the use of wxPython (from wxWidgets). Users wanting to write Python code for RIDE, should be acquainted with https://wxpython.org[wxPython] in particular by exploring its demo. @@ -122,7 +149,7 @@ should be clear enough that comments are generally not needed. All code, including test code, must be compatible with all supported Python interpreters and versions. Most importantly this means that the -code must support Python 3 (actually, greater than 3.6). RIDE's code still have some Python 2 conditioning, due to its dual compatibility on version 1.7.4.2, and also in the included Robot Framework library from version 3.1.2. +code must support Python 3 (actually, greater than 3.7, currently 3.13). RIDE's code may still have some Python 2 conditioning, due to its dual compatibility on version 1.7.4.2, and also in the included Robot Framework library from version 3.1.2. ==== Line length @@ -225,7 +252,7 @@ Please contact us via Slack, if you would like to join this testing group. Once you have code, documentation and tests ready, it is time to finalize the pull request. -=== Acknowledgments +=== Acknowledgements If you have done any non-trivial change and would like to be credited, remind us to add `acknowledge` tag to the issue. This way we will add diff --git a/doc/releasenotes/ride-2.1.1.rst b/doc/releasenotes/ride-2.1.1.rst new file mode 100644 index 000000000..04930646a --- /dev/null +++ b/doc/releasenotes/ride-2.1.1.rst @@ -0,0 +1,119 @@ +.. container:: document + + `RIDE (Robot Framework + IDE) `__ v2.1.1 is a new + release with some enhancements and bug fixes. The reference for valid + arguments is `Robot Framework `__ + installed version, which is at this moment 7.1.1. However, internal + library code is originally based on version 3.1.2, but adapted for + new versions. + + - This version supports Python 3.8 up to 3.13. + - There are some changes, or known issues: + + - 🐞 - When upgrading RIDE and activate Restart, some errors are + visible about missing /language file, and behaviour is not + normal. Better to close RIDE and start a new instance. + - 🐞 - Problems with COPY/PASTE in Text Editor have been reported + when using wxPython 4.2.0, but not with version 4.2.1 and + 4.2.2, which we now *recommend*. + - 🐞 - Some argument types detection (and colorization) is not + correct in Grid Editor. + - 🐞 - RIDE **DOES NOT KEEP** Test Suites formatting or + structure, causing differences in files when used on other IDE + or Editors. The option to not reformat the file is not working. + + **New Features and Fixes Highlights** + + - Fixed long arguments in fixtures appearing splitted in Grid + Editor. Still, arguments info will not be correct at calling + step. + - Fixed double action on Linux when pressing the DEL key + + **The minimal wxPython version is, 4.0.7, and RIDE supports the + current version, 4.2.2, which we recommend.** + + *Linux users are advised to install first wxPython from .whl package + at* + `wxPython.org `__, + or by using the system package manager. + + The + `CHANGELOG.adoc `__ + lists the changes done on the different versions. + + All issues targeted for RIDE v2.2 can be found from the `issue + tracker + milestone `__. + + Questions and comments related to the release can be sent to the + `robotframework-users `__ + mailing list or to the channel #ride on `Robot Framework + Slack `__, and + possible bugs submitted to the `issue + tracker `__. You + should see `Robot Framework + Forum `__ if your + problem is already known. + + To install the latest release with + `pip `__ installed, just run + + .. code:: literal-block + + pip install --upgrade robotframework-ride==2.1.1 + + to install exactly the specified release, which is the same as using + + .. code:: literal-block + + pip install --upgrade robotframework-ride + + Alternatively you can download the source distribution from + `PyPI `__ and + install it manually. For more details and other installation + approaches, see the `installation + instructions `__. + If you want to help in the development of RIDE, by reporting issues + in current development version, you can install with: + + .. code:: literal-block + + pip install -U https://github.com/robotframework/RIDE/archive/develop.zip + + Important document for helping with development is the + `CONTRIBUTING.adoc `__. + + To start RIDE from a command window, shell or terminal, just enter: + + :: + + ride + + You can also pass some arguments, like a path for a test suite file + or directory. + + :: + + ride example.robot + + Another possible way to start RIDE is: + + .. code:: literal-block + + python -m robotide + + You can then go to Tools>Create RIDE Desktop Shortcut, or run the + shortcut creation script with: + + .. code:: literal-block + + python -m robotide.postinstall -install + + or + + .. code:: literal-block + + ride_postinstall.py -install + + RIDE v2.1.1 was released on 14/November/2024. diff --git a/src/robotide/application/releasenotes.py b/src/robotide/application/releasenotes.py index 18cbeaeac..a3609c0b7 100644 --- a/src/robotide/application/releasenotes.py +++ b/src/robotide/application/releasenotes.py @@ -125,7 +125,7 @@ def set_content(self, html_win, content): milestone = re.split('[ab-]', VERSION)[0] WELCOME_TEXT = f""" -

Welcome to use RIDE DEVELOPMENT version {version}

+

Welcome to use RIDE version {version}

Thank you for using the Robot Framework IDE (RIDE).

@@ -171,8 +171,7 @@ def set_content(self, html_win, content):
  • Fixed broken go to definition after editing content in resource files.
  • Fixed long arguments in fixtures appearing splitted in Grid Editor. Still, arguments info will not be correct at - calling step. Fixed long arguments in fixtures appearing splitted in Grid Editor. - Still, arguments info will not be correct at calling step.
    • + calling step.
  • Fixed double action on Linux when pressing the DEL key