Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.8k
WIP update the CONTRIBUTING.md guide.#1203
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:develop
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
vercelbot commentedJun 5, 2020 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Maybe we should mention thedev command before this ?
like after installnpm run dev for streamline one you mentioned below and then thisbuild 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I don't think we should suggest usingnpx 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> . |
codesandbox-cibot commentedJun 8, 2020 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
This pull request is automatically built and testable inCodeSandbox. To see build info of the built libraries, clickhere or the icon next to each commit SHA. Latest deployment of this branch, based on commit34df471:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I don't think we should suggest usingnpx 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Development server runs on port 3000.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
- update port
- change to
npmcommand
I agree about the change. Sidenote, I thinknpx falls back to the same asnpm and uses the local dependency without the internet when the local dependency is installed.
trusktr commentedOct 9, 2020 • edited by jhildenbiddle
Loading Uh oh!
There was an error while loading.Please reload this page.
edited by jhildenbiddle
Uh oh!
There was an error while loading.Please reload this page.
👍
|
Uh oh!
There was an error while loading.Please reload this page.
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 thebefore/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 anew feature, the PR's description includes:
To avoid wasting your time, it's best to open afeature request issue first and wait for approval before working on it.
Other information:
Just updating docs for contributing.