Skip to content

Commit 7dbacc0

Browse files
Merge pull request #3151 from faker-ruby/sb-3150-revamp-docs
Revamp the docs to make them easier to find
2 parents 81b58ac + de6e845 commit 7dbacc0

File tree

3 files changed

+636
-393
lines changed

3 files changed

+636
-393
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.

0 commit comments

Comments
 (0)