Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): add GIF showcasing the watch script #642

Merged

Conversation

petermetz
Copy link
Contributor

@petermetz petermetz commented Mar 9, 2021

Dependencies

Depends on #656

Commit to be reviewed

docs(readme): add reference to BUILD.md

BUILD.md: add GIF showcasing the watch script

We've received feedback from multiple people that long build
times are tedious and reduce general productivity which is
(probably) hindering the growth of the community so here is
a video guide (GIF) on how fast builds can be achieved by
only rebuilding what you actually changed on the package level.

It also comes with support for regenerating the code that we
don't write ourselves but use the OpenAPI generator for it instead.
All the openapi.json files are being watched by the npm run watch
script for code changes the same way that Typescript files are being
watched so this just works out of the box.

Signed-off-by: Peter Somogyvari peter.somogyvari@accenture.com

@petermetz petermetz added the documentation Improvements or additions to documentation label Mar 9, 2021
@petermetz petermetz enabled auto-merge (rebase) March 9, 2021 23:42
@petermetz petermetz disabled auto-merge March 11, 2021 17:54
@petermetz petermetz force-pushed the docs/readme/add-watch-script-gif branch from 9a94289 to e114b15 Compare March 23, 2021 16:24
@petermetz petermetz requested review from takeutak and sfuji822 and removed request for sfuji822 and takeutak March 23, 2021 16:25
@petermetz
Copy link
Contributor Author

@sfuji822 @takeutak Pushed changes according to the change requests.

@petermetz petermetz force-pushed the docs/readme/add-watch-script-gif branch from e114b15 to 7110f15 Compare March 24, 2021 01:47
@petermetz petermetz force-pushed the docs/readme/add-watch-script-gif branch from 7110f15 to 05c340f Compare March 24, 2021 02:19
@github-actions
Copy link

🎉 Great news! Looks like all the dependencies have been resolved:

💡 To add or remove a dependency please update this issue/PR description.

Brought to you by Dependent Issues (:robot: ). Happy coding!

@petermetz petermetz force-pushed the docs/readme/add-watch-script-gif branch from 05c340f to fa52107 Compare March 28, 2021 05:04
Copy link
Contributor

@jonathan-m-hamilton jonathan-m-hamilton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@petermetz
Copy link
Contributor Author

@sfuji822 @takeutak Kindly requesting that you review this pull request. Thank you very much in advance.

BUILD.md: add GIF showcasing the watch script

We've received feedback from multiple people that long build
times are tedious and reduce general productivity which is
(probably) hindering the growth of the community so here is
a video guide (GIF) on how fast builds can be achieved by
only rebuilding what you actually changed on the package level.

It also comes with support for regenerating the code that we
don't write ourselves but use the OpenAPI generator for it instead.
All the openapi.json files are being watched by the `npm run watch`
script for code changes the same way that Typescript files are being
watched so this just works out of the box.

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
@petermetz petermetz force-pushed the docs/readme/add-watch-script-gif branch from fa52107 to 31415cf Compare April 5, 2021 18:26
@petermetz
Copy link
Contributor Author

@sfuji822 @takeutak Kindly requesting that you review or follow-up on the review discussion within this pull request (whichever is applicable). Thank you very much in advance.

@takeutak
Copy link
Contributor

takeutak commented Apr 17, 2021

@petermetz Sorry for late replying. I missed updates of this PR. I approved it a moment ago.

@petermetz
Copy link
Contributor Author

@petermetz Sorry for late replying. I missed updates of this PR. I approved it a moment ago.

@takeutak No worries, thank you!

@petermetz petermetz merged commit 82f4bb9 into hyperledger-cacti:main Apr 17, 2021
@petermetz petermetz deleted the docs/readme/add-watch-script-gif branch April 17, 2021 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants