Add new development documentation section "Development on Windows"

- Fixes #9540
- Remove duplicate name in contributors
pull/9532/head
DokuaAsiedu 2022-11-01 00:33:30 +00:00 zatwierdzone przez LB (Ben Johnston)
rodzic f41a219697
commit 7ae2625132
4 zmienionych plików z 19 dodań i 1 usunięć

Wyświetl plik

@ -21,6 +21,7 @@ Changelog
* Migrated `initSkipLink` util to TypeScript and add JSDoc & unit tests (Juliet Adeboye)
* Clean up some unused utility classes and migrate `unlist` to Tailwind utility class `w-list-none` (Loveth Omokaro)
* Ensure that the `rebuild_references_index` command can run without console output if called with `--verbosity 0` (Omerzahid Ali, Aman Pandey)
* Add development (contributing to Wagtail) documentation notes for development on Windows (Akua Dokua Asiedu)
* Fix: Make sure workflow timeline icons are visible in high-contrast mode (Loveth Omokaro)
* Fix: Ensure authentication forms (login, password reset) have a visible border in Windows high-contrast mode (Loveth Omokaro)
* Fix: Ensure visual consistency between buttons and links as buttons in Windows high-contrast mode (Albina Starykova)

Wyświetl plik

@ -642,7 +642,6 @@ Contributors
* Loveth Omokaro
* Abayomi Victory
* Victoria Poromon
* Dokua Asiedu
* Darrel O'Pry
* Mary Ayobami
* Bolarinwa Comfort Ajayi

Wyświetl plik

@ -46,6 +46,23 @@ npm run build
Any Wagtail sites you start up in this virtualenv will now run against this development instance of Wagtail. We recommend using the [Wagtail Bakery demo site](https://github.com/wagtail/bakerydemo/) as a basis for developing Wagtail. Keep in mind that the setup steps for a Wagtail site may include installing a release version of Wagtail, which will override the development version you've just set up. In this case, you should install the site before running the `pip install -e` step, or re-run that step after the site is installed.
(development_on_windows)=
## Development on Windows
Documentation for development on Windows has some gaps and should be considered a work in progress. We recommend setting up on a local virtual machine using our already available scripts, [docker-wagtail-develop](https://github.com/wagtail/docker-wagtail-develop) or [vagrant-wagtail-develop](https://github.com/wagtail/vagrant-wagtail-develop)
If you are confident with Python and Node development on Windows and wish to proceed here are some helpful tips.
We recommend [Chocolatey](https://chocolatey.org/install) for managing packages in Windows. Once Chocolatey is installed you can then install the [`make`](https://community.chocolatey.org/packages/make) utility in order to run common build and development commands.
To effectively collaborate with other developers on different operating systems, we use CRLF to handle our line endings. You can configure this in Git using:
```doscon
# Configures how Git handles line endings and sets the value to True
git config --global core.autocrlf true
```
(testing)=
## Testing

Wyświetl plik

@ -30,6 +30,7 @@ depth: 1
* Migrated `initSkipLink` util to TypeScript and add JSDoc & unit tests (Juliet Adeboye)
* Clean up some unused utility classes and migrate `unlist` to Tailwind utility class `w-list-none` (Loveth Omokaro)
* Ensure that the `rebuild_references_index` command can run without console output if called with `--verbosity 0` (Omerzahid Ali, Aman Pandey)
* Add development (contributing to Wagtail) documentation notes for [development on Windows](development_on_windows) (Akua Dokua Asiedu)
### Bug fixes