@@ -64,50 +64,6 @@ about how to get started. To make a change to IDOM you'll do the following:
6464 At that point your contribution will be merged into the main codebase!
6565
6666
67- Creating a Changelog Entry
68- --------------------------
69-
70- As part of your pull request, you'll want to edit the `Changelog
71- <https://github.com/idom-team/idom/blob/main/docs/source/about/changelog.rst> `__ by
72- adding an entry describing what you've changed or improved. You should write an entry in
73- the style of `Keep a Changelog <https://keepachangelog.com/ >`__ that falls under one of
74- the following categories, and add it to the :ref: `Unreleased ` section of the changelog:
75-
76- - **Added ** - for new features.
77- - **Changed ** - for changes in existing functionality.
78- - **Deprecated ** - for soon-to-be removed features.
79- - **Removed ** - for now removed features.
80- - **Fixed ** - for any bug fixes.
81- - **Documented ** - for improvements to this documentation.
82- - **Security ** - in case of vulnerabilities.
83-
84- If one of the sections doesn't exist, add it. If it does already, add a bullet point
85- under the relevant section. Your description should begin with a reference to the
86- relevant issue or pull request number. Here's a short example of what an unreleased
87- changelog entry might look like:
88-
89- .. code-block :: rst
90-
91- Unreleased
92- ----------
93-
94- **Added**
95-
96- - :pull:`123` - A really cool new feature
97-
98- **Changed**
99-
100- - :pull:`456` - The behavior of some existing feature
101-
102- **Fixed**
103-
104- - :issue:`789` - Some really bad bug
105-
106- .. hint ::
107-
108- ``:issue: `` and ``:pull: `` refer to issue and pull request ticket numbers.
109-
110-
11167Development Environment
11268-----------------------
11369
@@ -136,7 +92,7 @@ In order to develop IDOM locally you'll first need to install the following:
13692 * - NPM >= 7.13
13793 - https://docs.npmjs.com/try-the-latest-stable-version-of-npm
13894
139- * - Docker
95+ * - Docker (optional)
14096 - https://docs.docker.com/get-docker/
14197
14298.. note ::
@@ -175,35 +131,38 @@ However you may also ``cd`` to the ``src/client`` directory which contains a
175131Running The Tests
176132-----------------
177133
178- The test suite for IDOM is executed with Nox _. The suite covers:
134+ The test suite for IDOM is executed with Nox _, which should already be installed if you
135+ followed the `earlier instructions <Development Environment >`_. The suite covers:
179136
1801371. Server-side Python code with PyTest _
181138
182- 2. The end-to-end application using Selenium _ in Python
139+ 2. The end-to-end application using Playwright _ in Python
183140
1841413. Client-side Javascript code with UVU _
185142
186- To run the full suite of tests you'll need to install:
143+ Before running the test suite you'll need to install the required browsers by running :
187144
188- - ` Google Chrome `_
145+ .. code-block :: bash
189146
190- - ChromeDriver _.
147+ playwright install
191148
192- .. warning : :
149+ Once you've installed them you'll be able to run :
193150
194- Be sure the version of ` Google Chrome `_ and ChromeDriver _ you install are compatible.
151+ .. code-block :: bash
195152
196- Once you've installed the aforementioned browser and web driver you'll be able to run:
153+ nox -s test
154+
155+ You can observe the browser as the tests are running by passing an extra flag:
197156
198157.. code-block :: bash
199158
200- nox -s test
159+ nox -s test -- --headed
201160
202- If you prefer to run the tests using a headless browser :
161+ To see a full list of available commands (e.g. `` nox -s <your-command> ``) run :
203162
204163.. code-block :: bash
205164
206- nox -s test -- --headless
165+ nox -l
207166
208167
209168 Code Quality Checks
@@ -270,6 +229,50 @@ installed Docker, you can run:
270229 Where you can then navigate to http://localhost:5000..
271230
272231
232+ Creating a Changelog Entry
233+ --------------------------
234+
235+ As part of your pull request, you'll want to edit the `Changelog
236+ <https://github.com/idom-team/idom/blob/main/docs/source/about/changelog.rst> `__ by
237+ adding an entry describing what you've changed or improved. You should write an entry in
238+ the style of `Keep a Changelog <https://keepachangelog.com/ >`__ that falls under one of
239+ the following categories, and add it to the :ref: `Unreleased ` section of the changelog:
240+
241+ - **Added ** - for new features.
242+ - **Changed ** - for changes in existing functionality.
243+ - **Deprecated ** - for soon-to-be removed features.
244+ - **Removed ** - for now removed features.
245+ - **Fixed ** - for any bug fixes.
246+ - **Documented ** - for improvements to this documentation.
247+ - **Security ** - in case of vulnerabilities.
248+
249+ If one of the sections doesn't exist, add it. If it does already, add a bullet point
250+ under the relevant section. Your description should begin with a reference to the
251+ relevant issue or pull request number. Here's a short example of what an unreleased
252+ changelog entry might look like:
253+
254+ .. code-block :: rst
255+
256+ Unreleased
257+ ----------
258+
259+ **Added**
260+
261+ - :pull:`123` - A really cool new feature
262+
263+ **Changed**
264+
265+ - :pull:`456` - The behavior of some existing feature
266+
267+ **Fixed**
268+
269+ - :issue:`789` - Some really bad bug
270+
271+ .. hint ::
272+
273+ ``:issue: `` and ``:pull: `` refer to issue and pull request ticket numbers.
274+
275+
273276Release Process
274277---------------
275278
@@ -332,7 +335,7 @@ you should refer to their respective documentation in the links below:
332335.. _PyPI : https://pypi.org/project/idom
333336.. _pip : https://pypi.org/project/pip/
334337.. _PyTest : pytest <https://docs.pytest.org
335- .. _ Selenium : https://www.seleniumhq.org /
338+ .. _ Playwright : https://playwright.dev/python /
336339.. _Nox : https://nox.thea.codes/en/stable/#
337340.. _React : https://reactjs.org/
338341.. _Heroku : https://www.heroku.com/what
0 commit comments