WIP update the CONTRIBUTING.md guide.

[trusktr]

Summary

Improve the contributing guidelines and documentation.

TODO:

• [ ] improve CONTRIBUTING.md
• [ ] Fix broken Contributing page: https://docsify.js.org/#/contributing. It is linked to here: https://docsify.js.org/#/awesome?id=contributing

What kind of change does this PR introduce? (check at least one)

• [ ] Bugfix
• [ ] Feature
• [ ] Code style update
• [ ] Refactor
• [x] Docs
• [ ] Build-related changes
• [ ] Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

• [ ] Yes
• [x] No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

• [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

• [ ] Chrome
• [ ] Firefox
• [ ] Safari
• [ ] Edge
• [ ] IE

If adding a new feature, the PR's description includes:

• [ ] A convincing reason for adding this feature
• [ ] Related documents have been updated
• [ ] Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

Just updating docs for contributing.

[vercel[bot]]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/rf0rv0cud
✅ Preview: https://docsify-preview-git-contributing-guide.docsify-core.vercel.app

[trusktr]

Sounds good :) *#!/*JoePea

On Fri, Jun 5, 2020 at 12:47 PM Anix [email protected] wrote:

@anikethsaha requested changes on this pull request.

In CONTRIBUTING.md https://github.com/docsifyjs/docsify/pull/1203#discussion_r436128923:

@@ -15,9 +15,39 @@ We welcome any type of contribution, not only code. You can help with

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

+### Developing + +After cloning the project, run the following in your terminal + +```sh +npm install +npm run build +npx serve .

Maybe we should mention the dev command before this ?

like after install npm run dev for streamline one you mentioned below and then this build thing ?

WDYT ?

cause we have the same in gitpod environment as well so for consistency we can have that.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/docsifyjs/docsify/pull/1203#pullrequestreview-425580725, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACIVTXMPC7GN5G2FOUJ5KTRVFDWDANCNFSM4NU4NZEQ .

[codesandbox-ci[bot]]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 34df47139ec36962cea3b1cfacb993ba973dca7f:

Sandbox	Source
docsify-template	Configuration

[trusktr]

Per the #maintainers discussion on Discuss, let's also add information regarding our agreed commit convention: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit

:+1:

• [ ] update commit format