doc: add developer guide #28
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ruanyl
force-pushed
the
doc-developer-guide
branch
from
f6447ae
to
bc2c530
Compare
wanglam
reviewed
Dec 19, 2022
wanglam
reviewed
Dec 19, 2022
wanglam
reviewed
Dec 19, 2022
ruanyl
force-pushed
the
doc-developer-guide
branch
from
0655951
to
52dde75
Compare
raintygao
reviewed
Jan 12, 2023
| # start OSD dev server | ||
| yarn start | ||
| ``` | ||
| If everything went well, OSD will be available on `http://localhost:5601/` |
There was a problem hiding this comment.
The situation in my here is 5603, @wanglam what's yours?
There was a problem hiding this comment.
I am using 5601 too, seems the server will listen both 5601 and 5603. One for development and another one seems is a proxy server.
|
|
||
| ### Tagging & Versioning | ||
|
|
||
| ## Project Conventions |
There was a problem hiding this comment.
What does this part consist of ? For some items, I think we can inherit from OSD, also including eslint and prettier config, similar to the OSD to ensure code style consistent for contributors.
There was a problem hiding this comment.
Sounds good, I will add a link to the section of OSD
ruanyl
force-pushed
the
doc-developer-guide
branch
2 times, most recently
from
01d2e0c
to
acaa46a
Compare
wanglam
force-pushed
the
feat-admin-ui
branch
from
12da8b2
to
d21c743
Compare
raintygao
force-pushed
the
feat-admin-ui
branch
from
d21c743
to
801794b
Compare
wanglam
force-pushed
the
feat-admin-ui
branch
from
801794b
to
e3f6c52
Compare
Signed-off-by: Yulong Ruan <[email protected]>
ruanyl
force-pushed
the
doc-developer-guide
branch
from
2df32ce
to
cd7dfb1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @wanglam @raintygao @xyinshen, I initiated a draft of developer guide for the project, I'd like to invite you to collaborate on this PR, feel free to make changes to this PR.
Signed-off-by: Yulong Ruan [email protected]
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.