Skip to content

Commit 2db50b4

Browse files
Add one more example of contributions we're accepting
For locales updates, we review them to avoid merging harmful/offensive words. But for older locales, it's possible there might be some lingering.
1 parent 7ed3db7 commit 2db50b4

File tree

2 files changed

+17
-18
lines changed

2 files changed

+17
-18
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ faker-ruby already has lots of generators and locales. We appreciate any efforts
2424
- adding new translations
2525
- updating the existing translations
2626
- fixing any outdated/wrong translations
27+
- removing harmful/offensive words from locales
2728

2829
> [!NOTE]
2930
> Please include the console output of the translations in the PR description. Run `bundle exec rake console` to confirm the translations are working as expected. [Here's an example](https://github.com/faker-ruby/faker/pull/2960#issuecomment-2159698291).
@@ -192,7 +193,6 @@ DEPRECATION WARNING: Faker::IDNumber is deprecated. Use Faker::IdNumber instead.
192193
We recommend adding tests for both the deprecated and new generators to ensure that the deprecation process is working as expected.
193194
Check out this [PR](https://github.com/faker-ruby/faker/pull/2856) for reference.
194195

195-
196196
## YAML files
197197

198198
Please use dash syntax for YAML arrays. The dash syntax facilitates code reviews by making it easier to see what items were added or removed from the lists.
@@ -236,7 +236,6 @@ What happens if the build fails in some way? Don't fear! Click on a failed job a
236236

237237
There is a custom git hooks pre-push file. Before the push occurs, it runs the tests and Rubocop. If there are any tests failures, or Rubocop offenses, the push is aborted.
238238

239-
240239
To set up:
241240
- Copy the file `pre-push.sample` located in the `custom-hooks` folder.
242241
- Paste it in your `.git/hooks` folder without the `.sample` extension.

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@
2323

2424
## Features
2525

26-
- Internet: Generate Email addresses, Passwords, Domains, etc.
26+
- Internet: Email addresses, Passwords, Domains, etc.
2727
- Date and Time: Travel back in time or to the future.
28-
- Person: Generate Names, Genders, Bios, Job titles, and more.
29-
- Number and String: Generate random numbers and strings.
30-
- Location: Generate Addresses, Zip Codes, Street Names, States, and Countries.
31-
- Finance: Create Account Details, Transactions, and Crypto Addresses.
32-
- Localization - Pick from over 40 locales to generate realistic looking Names, Addresses, and Phone Numbers.
28+
- Person: Names, Genders, Bios, Job titles, and more.
29+
- Number add String: Random numbers and strings.
30+
- Location: Addresses, Zip Codes, Street Names, States, and Countries.
31+
- Finance: Account Details, Transactions, and Crypto Addresses.
32+
- Localization - Customize faker with over 40 locales to generate realistic-looking Names, Addresses, and Phone Numbers.
3333

34-
> [!IMPORTANT] The generated names, addresses, emails, phone numbers, and/or other data might be coincidentally valid information. Please be careful when using faker for testing.
34+
> **Note** The generated names, addresses, emails, phone numbers, and/or other data might return valid information. Please be careful when using faker in your tests.
3535
3636
For a complete list of the generators, see [Generators](./GENERATORS.md).
3737

@@ -71,7 +71,7 @@ Faker::ProgrammingLanguage.name #=> "Ruby"
7171
- [Notes](#notes)
7272
- [Ensuring unique values](#ensuring-unique-values)
7373
- [Deterministic Random](#deterministic-random)
74-
- [Customization](#customization)
74+
- [Localization](#localization)
7575
- [Minitest and Faker \>= 2.22](#minitest-and-faker--222)
7676
- [Generators](#generators)
7777
- [Contributing](#contributing)
@@ -122,19 +122,19 @@ to provide deterministic output of repeated method calls.
122122

123123
```ruby
124124
Faker::Config.random = Random.new(42)
125-
Faker::Lorem.word #=> "velit"
126-
Faker::Lorem.word #=> "quisquam"
125+
Faker::Lorem.word #=> "velit"
126+
Faker::Lorem.word #=> "quisquam"
127127

128128
Faker::Config.random = Random.new(42)
129-
Faker::Lorem.word #=> "velit"
130-
Faker::Lorem.word #=> "quisquam"
129+
Faker::Lorem.word #=> "velit"
130+
Faker::Lorem.word #=> "quisquam"
131131

132-
Faker::Config.random = nil # seeds the PRNG using default entropy sources
133-
Faker::Config.random.seed #=> 185180369676275068918401850258677722187
134-
Faker::Lorem.word #=> "ipsam"
132+
Faker::Config.random = nil # seeds the PRNG using default entropy sources
133+
Faker::Config.random.seed #=> 185180369676275068918401850258677722187
134+
Faker::Lorem.word #=> "ipsam"
135135
```
136136

137-
### Customization
137+
### Localization
138138

139139
You may want Faker to print information depending on your location in the world.
140140
To assist you in this, Faker uses the `I18n` gem to store strings and formats to

0 commit comments

Comments
 (0)