From 8ddfb68b07ec3b8f25f8f76717c131a9766c38c7 Mon Sep 17 00:00:00 2001 From: Tristan F Date: Sat, 31 Dec 2022 14:27:17 -0500 Subject: [PATCH 1/3] Add a note about using flow in CONTRIBUTING.md --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0c833cbec6..f4f8791ca3a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,8 @@ In order to make it easier to get familiar with the codebase we labeled simpler Before starting make sure you have the following requirements installed: [git](https://git-scm.com), [Node](https://nodejs.org), [Yarn](https://yarnpkg.com) and [Rust](https://www.rust-lang.org/tools/install). +Parcel uses [flow](https://flow.org) for type checking. If you're using an IDE, make sure to install the [flow extension](https://flow.org/en/docs/editors/) to get the best experience. + The process starts by [forking](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the project and setup a new branch to work in. It's important that the changes are made in separated branches in order to ensure a pull request only includes the commits related to a bug or feature. Clone the forked repository locally and install the dependencies: From d2920a990454faf7d6573d1587e401c772f98a33 Mon Sep 17 00:00:00 2001 From: Tristan F Date: Sat, 31 Dec 2022 14:32:59 -0500 Subject: [PATCH 2/3] Elaborate on why using the flow extension helps --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4f8791ca3a..52896efe00f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ In order to make it easier to get familiar with the codebase we labeled simpler Before starting make sure you have the following requirements installed: [git](https://git-scm.com), [Node](https://nodejs.org), [Yarn](https://yarnpkg.com) and [Rust](https://www.rust-lang.org/tools/install). -Parcel uses [flow](https://flow.org) for type checking. If you're using an IDE, make sure to install the [flow extension](https://flow.org/en/docs/editors/) to get the best experience. +Parcel uses [flow](https://flow.org) for type checking. If you're using an IDE, make sure to install the [flow extension](https://flow.org/en/docs/editors/) to ensure your editor's autocomplete and type-checking works as expected. The process starts by [forking](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the project and setup a new branch to work in. It's important that the changes are made in separated branches in order to ensure a pull request only includes the commits related to a bug or feature. From 59bc2bdfefc15cd3ef54bcd24a3ceaa8fa359d3a Mon Sep 17 00:00:00 2001 From: Niklas Mischkulnig <4586894+mischnic@users.noreply.github.com> Date: Sat, 31 Dec 2022 23:31:36 +0100 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52896efe00f..97a638d07a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ In order to make it easier to get familiar with the codebase we labeled simpler Before starting make sure you have the following requirements installed: [git](https://git-scm.com), [Node](https://nodejs.org), [Yarn](https://yarnpkg.com) and [Rust](https://www.rust-lang.org/tools/install). -Parcel uses [flow](https://flow.org) for type checking. If you're using an IDE, make sure to install the [flow extension](https://flow.org/en/docs/editors/) to ensure your editor's autocomplete and type-checking works as expected. +Parcel uses [Flow](https://flow.org) for type checking. If you're using an IDE, make sure to install the [Flow extension](https://flow.org/en/docs/editors/) to ensure your editor's autocomplete and type-checking works as expected. The process starts by [forking](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the project and setup a new branch to work in. It's important that the changes are made in separated branches in order to ensure a pull request only includes the commits related to a bug or feature.