|
1 | 1 | A lot of effort has been put into `Faker` to create a useful and handy library.
|
2 | 2 | There are still a lot of things to be done, so all contributions are welcome!
|
3 |
| -If you want to make `Faker` a better, please read the following contribution guide. |
| 3 | +If you want to make `Faker` a better place, please read the following contribution guide. |
4 | 4 |
|
5 |
| -# Important |
| 5 | +## Before you start |
| 6 | + |
| 7 | +It's generally helpful to [create an issue](https://github.com/faker-js/faker/issues/new/choose) first: |
| 8 | + |
| 9 | +- If you are proposing a new feature, this allows other users to "upvote" the issue and discuss solutions to possible problems. |
| 10 | + Once an issue has enough upvotes (usually 10+) it will be reviewed for development. |
| 11 | +- If you notice a bug, this allows you to provide steps to reproduce, and allows other users to confirm this is actually a bug. |
| 12 | +- It's not required to create an issue in all cases. |
| 13 | + 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. |
| 14 | + |
| 15 | +## Important |
6 | 16 |
|
7 | 17 | Please make sure that you run `pnpm run preflight` before making a PR to ensure that everything is working from the start.
|
8 | 18 | This is a shorthand for running the following scripts in order:
|
@@ -218,7 +228,7 @@ Not every change needs to be in the migration guide. If it is too long, it becom
|
218 | 228 |
|
219 | 229 | - New locales
|
220 | 230 | - Changes to locale data in existing locales
|
221 |
| -- Bugfixes where it's unlikely anyone was relying on the old behavior (eg broken values in locale files) |
| 231 | +- Bugfixes where it's unlikely anyone was relying on the old behavior (e.g. broken values in locale files) |
222 | 232 | - New methods and parameters
|
223 | 233 | - 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)
|
224 | 234 | - 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
|
|
0 commit comments