docs(web): add contributing pages #2869
Conversation
✅ Deploy Preview for fakerjs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #2869 +/- ##
=======================================
Coverage 99.97% 99.97%
=======================================
Files 2880 2880
Lines 220510 220510
Branches 953 950 -3
=======================================
Hits 220457 220457
Misses 53 53 🚀 New features to boost your workflow:
|
|
|
||
| ::: 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.
|
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: ST-DDT <ST-DDT@gmx.de>
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
bad0b29 to
e814746
Compare
|
This PR is now ready for reaview. I've updated the description, in the hope of bringing more clearity to the intend of the PR. Please read it before asking new questions regarding the overall matter. |
There was a problem hiding this comment.
@xDivisionByZerox This is AWESOME!
I read through all of it word by word and oh my god 🚀
The goal of this PR is to fix #1513.
Similar to ESLint's Contribution documentation, this PR adds a new "Contributing" Section to our Webdocumentation. The overall goal of this (as well as follow up PRs) was to migrate the contents of the CONTRIBUTION file on GitHub with a full fledged documentation on our website. Having the the additional mark up power of vitepress lets us structure these docs in a more abstract why than to dump everything into a single play markdown file.
Since this has already been questioned in the comments, I'll hope to discuss the matter with you in the PR or a team meeting.
My plan is to add an additional "Active Development" page later on.
This way the rest of the CONTRIUTION section can be addresses in a meaningmul way, without making the "Submit a Pull Request" page more overwhelming than it already is.
I'm open to additional suggestion, tho.
Do not forget to check out the new docs via the netlify deploy preview.
Note
I'll admit that I've used the help of some AI tools to structure the overall file hierarchy. Since I am not native in English, I do hope this reduces the need for spelling and grammar fixes drastically as well.
Important
My commit messages are marked as "Unverified" right now, since my PC broke down last Thursday. I'm currently on a temporary device which I am to lazy to configure. Sorry for the inconvenience.