-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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] Add a single-point starter guide for contributors #21322
Conversation
CONTRIBUTING_ROADMAP.md
Outdated
|
||
Keep in mind that we are here to help - **do not hesitate to ask the development team if something is not clear**. Such questions allow up to keep improving our documentation. | ||
|
||
## 1. Prerequisites |
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.
Would it make sense to also provide short tutorial/link on how to use git? It doesn't need to be external one, we can redirect to our internal one -- something similar to this: https://numpy.org/doc/stable/dev/index.html#development-process-summary
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.
Good point, from what I've seen a great deal of contributors are not familiar with working with forks. I'll think about how to deal with that, a guide on working with many remotes and forking tailored specifically for OV might be a good idea.
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.
As we discussed, it's worth to consider a FAQ (Frequently Asked Questions) section.
It could be supported by links to the already existing useful comments from reviewers/maintainers for issues, where such question was already resolved.
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.
That is a very cool addition! I've added tiny language adjustments but they are barely relevant.
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
please add ticket ID which you will use to follow up |
@mlukasze done.
Continued in 127561.
Continued in 127562. |
Details:
TODO
I believe we should simplify CONTRIBUTING.md, CONTRIBUTING_ROADMAP.md, get_started.md and so on, preferably merge into one"Roadmap" may be a confusing name, this document may require name changeTickets: