From 67cdf37554fce33afca0d41000ca7ef5d503a4c4 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Wed, 13 Mar 2024 23:51:51 +0100 Subject: [PATCH 1/3] docs: improve contributing guide --- CONTRIBUTING.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 198aee4f154..632ad918c72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,14 @@ A lot of effort has been put into `Faker` to create a useful and handy library. There are still a lot of things to be done, so all contributions are welcome! -If you want to make `Faker` a better, please read the following contribution guide. +If you want to make `Faker` a better place, please read the following contribution guide. -# Important +## Before you start + +- If you would like to propose a new feature, create an issue first. +- Bug fixes or locale changes don't need an issue. +- Issues with precise reproduction steps are a valuable contribution by itself. + +## Important Please make sure that you run `pnpm run preflight` before making a PR to ensure that everything is working from the start. This is a shorthand for running the following scripts in order: @@ -218,7 +224,7 @@ Not every change needs to be in the migration guide. If it is too long, it becom - New locales - Changes to locale data in existing locales -- Bugfixes where it's unlikely anyone was relying on the old behavior (eg broken values in locale files) +- Bugfixes where it's unlikely anyone was relying on the old behavior (e.g. broken values in locale files) - New methods and parameters - Straightforward method aliases, e.g. where a method or parameter is renamed but the old name still works identically. (Runtime warnings will already guide the user in this case) - Changes to locale definition files which only affect usage via `faker.helpers.fake`, e.g. if a definition file is renamed, but the public API for the method stays the same From b1a8d9f6e572fbea0e05d0dae32d82fc0c2a240d Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Thu, 14 Mar 2024 21:41:55 +0100 Subject: [PATCH 2/3] chore: apply suggestions --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 632ad918c72..c3532dfb707 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,9 +4,13 @@ If you want to make `Faker` a better place, please read the following contributi ## Before you start -- If you would like to propose a new feature, create an issue first. -- Bug fixes or locale changes don't need an issue. -- Issues with precise reproduction steps are a valuable contribution by itself. +It's generally helpful to create an issue first: + +- If you are proposing a new feature, this allows other users to "upvote" the issue and discuss solutions to possible problems. + Once an issue has enough upvotes (usually 10+) it will be reviewed for development. +- If you notice a bug, this allows you to provide steps to reproduce, and allows other users to confirm this is actually a bug. +- It's not required to create an issue in all cases. + For example for fixing a typo in documentation, or adding some new data for a locale, you could immediately create a pull request without an issue. ## Important From 67a5b238473a368d6e6af1f04f9dbe369000a901 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Fri, 15 Mar 2024 14:29:56 +0100 Subject: [PATCH 3/3] chore: add link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c3532dfb707..dd8c2f90e92 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ If you want to make `Faker` a better place, please read the following contributi ## Before you start -It's generally helpful to create an issue first: +It's generally helpful to [create an issue](https://github.com/faker-js/faker/issues/new/choose) first: - If you are proposing a new feature, this allows other users to "upvote" the issue and discuss solutions to possible problems. Once an issue has enough upvotes (usually 10+) it will be reviewed for development.