docs: add contributing pages #2869
Conversation
✅ Deploy Preview for fakerjs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #2869 +/- ##
==========================================
Coverage 99.96% 99.97%
==========================================
Files 2747 2747
Lines 239079 226148 -12931
Branches 591 941 +350
==========================================
- Hits 238999 226082 -12917
+ Misses 80 66 -14 |
| General criteria for new features are as follows: | ||
|
|
||
| - **Relevance**: Must be widely applicable and not specific to a particular niche. | ||
| - **Deterministic**: Functions must be based on Fakers internal [Randomizer](/api/randomizer). |
There was a problem hiding this comment.
Should we mention that transient usages of the Randomizer are allowed as well?
|
|
||
| ::: tip Note | ||
| Using thumb-up emotes ( :+1: ) on issues gives the faker team a general idea of the community interest in a feature. | ||
| If you see a feature request that you like, leave an up vote to increase interest. |
There was a problem hiding this comment.
Maybe mention comments to explain their requirements as well?
There was a problem hiding this comment.
Maybe add an additional section next to New Locale Criteria? Something like New Method Criteria, where we request acceptance critera from the issuer?
| If your feature isn't accepted into the library, you can still create it using Faker's Helper methods. | ||
| Our goal is to empower developers, not limit possibilities. | ||
|
|
||
| For more details on creating custom features, refer to our documentation on [Create Complex Objects](/guide/usage#create-complex-objects). |
There was a problem hiding this comment.
I'm not sure whether the Create Complex Objects page is the best page to refer to here, but I don't know any better either.
Co-authored-by: ST-DDT <[email protected]>
|
Is the end goal that this replaces CONTRIBUTING.md and that becomes a stub pointing at the web version? |
I hope not 👀 |
Co-authored-by: Eric Cheng <[email protected]>
Already creating a WIP-PR to let people preview the new contributing page for the website.
I'm still working on pages which are empty, since I'm only commiting entire pages for now!
You should be able to give feedback on pages that contain text.
The goal is to fix #1513.