Update README and CONTRIBUTING guides #2630
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jremes-foss
reviewed
Nov 23, 2022
jremes-foss
reviewed
Nov 23, 2022
jremes-foss
reviewed
Nov 23, 2022
thdaraujo
reviewed
Nov 27, 2022
Co-authored-by: Thiago Araujo <[email protected]>
Co-authored-by: Thiago Araujo <[email protected]>
Co-authored-by: Thiago Araujo <[email protected]>
Co-authored-by: Thiago Araujo <[email protected]>
Co-authored-by: Thiago Araujo <[email protected]>
Co-authored-by: Thiago Araujo <[email protected]>
Co-authored-by: Thiago Araujo <[email protected]>
Co-authored-by: Thiago Araujo <[email protected]>
Co-authored-by: Thiago Araujo <[email protected]>
Co-authored-by: Thiago Araujo <[email protected]>
Zeragamba
suggested changes
Nov 29, 2022
CONTRIBUTING.md
Outdated
|
|
||
| ## YAML files | ||
|
|
||
| Please use dash syntax for YAML arrays: |
There was a problem hiding this comment.
would be good to include the reason for the preference:
This allows for eaiser code reviews by making it eaiser to see what items were added or removed from the lists.
There was a problem hiding this comment.
I like that!
README.md
Outdated
Comment on lines
83
to
87
| See [Issue #2534](https://github.com/faker-ruby/faker/issues/2534) for more details. | ||
|
|
||
| *Note*: if you get a `uninitialized constant Faker::[some_class]` error, your version of | ||
| the gem is behind the one documented here. To make sure that your gem is the one | ||
| documented here, change the line in your Gemfile to: |
There was a problem hiding this comment.
we can also mention the @faker.version tag in the docs here to help users identify generators that were added with a particular version
Zeragamba
approved these changes
Nov 30, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our README, CONTRIBUTING, and MAINTAINING guides were needing a bit of love and attention ❤️ There were some outdated things there.
I added more examples to show the amazing generators we have :)
To make Faker more beginner-friendly, I followed the documentation from
shoulda-matchers. It helps new contributors to setup the library, manage their branches, and open PRs.I also added a new file for maintainers only. This is a Work in Progress.
What do you think? I'd love to hear your feedback!