faker icon indicating copy to clipboard operation
faker copied to clipboard

docs: add contributing pages

Open xDivisionByZerox opened this issue 1 year ago • 5 comments

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.

xDivisionByZerox avatar May 01 '24 18:05 xDivisionByZerox

Deploy Preview for fakerjs ready!

Name Link
Latest commit c2ae14fe3747b5e94db5b1c850eadfcd6df95b0f
Latest deploy log https://app.netlify.com/projects/fakerjs/deploys/685078ba7ddb4e0008eb9057
Deploy Preview https://deploy-preview-2869.fakerjs.dev
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar May 01 '24 18:05 netlify[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.97%. Comparing base (f08b243) to head (c2ae14f). Report is 2 commits behind head on next.

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #2869   +/-   ##
=======================================
  Coverage   99.97%   99.97%           
=======================================
  Files        2880     2880           
  Lines      220503   220510    +7     
  Branches      952      952           
=======================================
+ Hits       220450   220457    +7     
  Misses         53       53           

see 2 files with indirect coverage changes

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar May 01 '24 18:05 codecov[bot]

Is the end goal that this replaces CONTRIBUTING.md and that becomes a stub pointing at the web version?

matthewmayer avatar May 02 '24 11:05 matthewmayer

Is the end goal that this replaces CONTRIBUTING.md and that becomes a stub pointing at the web version?

I hope not 👀 IMO "contributing" is more a GitHub related thing, than a user facing documentation 🤔

Shinigami92 avatar May 02 '24 12:05 Shinigami92

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.

xDivisionByZerox avatar Jun 15 '25 20:06 xDivisionByZerox