WIP update the CONTRIBUTING.md guide. #1203
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/rf0rv0cud |
| ```sh | ||
| npm install | ||
| npm run build | ||
| npx serve . |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I don't think we should suggest using npx when we have npm scripts setup to accomplish the same thing (in this case, npm run serve). npx requires internet access which means it will fail when working offline, can be slow when internet speeds are slow (rural areas, mobile, developing countries, etc.) and/or expensive when internet charges are high (mobile, bandwidth limits, etc.)
Let's make sure the repo has everything needed for local development.
|
Sounds good :)
*#!/*JoePea
…On Fri, Jun 5, 2020 at 12:47 PM Anix ***@***.***> wrote:
***@***.**** requested changes on this pull request.
------------------------------
In CONTRIBUTING.md
<#1203 (comment)>:
> @@ -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](https://egghead.io/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
<#1203 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AACIVTXMPC7GN5G2FOUJ5KTRVFDWDANCNFSM4NU4NZEQ>
.
|
|
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 34df471:
|
trusktr
added
do not merge
WIP
docs
There was a problem hiding this comment.
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
| ```sh | ||
| npm install | ||
| npm run build | ||
| npx serve . |
There was a problem hiding this comment.
I don't think we should suggest using npx when we have npm scripts setup to accomplish the same thing (in this case, npm run serve). npx requires internet access which means it will fail when working offline, can be slow when internet speeds are slow (rural areas, mobile, developing countries, etc.) and/or expensive when internet charges are high (mobile, bandwidth limits, etc.)
Let's make sure the repo has everything needed for local development.
| npx serve . | ||
| ``` | ||
|
|
||
| The third command will output a URL like `http://localhost:5000`. Open it in your browser, then you'll see a directory listing. Click on the `docs/` folder and you'll then see the Docsify documentation (built with Docsify of course!) running locally on your computer. |
There was a problem hiding this comment.
Development server runs on port 3000.
There was a problem hiding this comment.
- update port
- change to
npmcommand
I agree about the change. Sidenote, I think npx falls back to the same as npm and uses the local dependency without the internet when the local dependency is installed.
👍
|
Summary
Improve the contributing guidelines and documentation.
TODO:
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx], where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
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.