Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve contributing guide #2747

Merged
merged 6 commits into from
Mar 16, 2024
Merged

docs: improve contributing guide #2747

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
67cdf37
docs: improve contributing guide
ST-DDT Mar 13, 2024
b1a8d9f
chore: apply suggestions
ST-DDT Mar 14, 2024
0301f79
Merge branch 'next' into docs/contributing
ST-DDT Mar 14, 2024
6b71d60
Merge branch 'next' into docs/contributing
ST-DDT Mar 15, 2024
67a5b23
chore: add link
ST-DDT Mar 15, 2024
bd50a3b
Merge branch 'next' into docs/contributing
ST-DDT Mar 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
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

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.
- 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

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:
Expand Down Expand Up @@ -218,7 +228,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
Expand Down