-
Notifications
You must be signed in to change notification settings - Fork 7
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
doc : Improve our CONTRIBUTING guide from a newcomer perspective #89
doc : Improve our CONTRIBUTING guide from a newcomer perspective #89
Conversation
This is OK, but it's not tackling the initial problem. We need to clearly define the types of good-first-issues. For example: first-timers-only: good-first-issue: help-wanted: |
Shall I add abovementioned paragraphs in |
src/content/contributing/index.mdx
Outdated
@@ -18,14 +18,49 @@ Thanks for being interested in contributing to Eclipse JKube! | |||
|
|||
This includes bug reports, fixes, documentation, examples... But first, please read this page. | |||
|
|||
## Table of Contents | |||
- ⚖️ [Legal](#legal) | |||
- 🐞[Reporting an issue](#reporting-an-issue) |
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.
a space seems to be missing here
It seems you did add these sections but I missed them. Please, merge anything that's not already stated in yours and add the third entry. I'm not sure if this is too far down in the page and users might miss it. |
Shall we split this page into multiple small pages? |
|
||
#### Finding an issue to work on | ||
|
||
You're free to start with any type of contribution, whether it is documentation or some issue you faced while |
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 would add an but we advise to start with a first-timers-only issue
somewhere here.
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 that's a good idea. |
8bb5be9
to
67d8098
Compare
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 would ditch the emojis, I think the rendering won't be uniform and the text to the right won't be correctly aligned.
Other than that, LGTM, and ready to go 🚀
Signed-off-by: Rohan Kumar <[email protected]>
67d8098
to
dda14ba
Compare
Updated contributing guide so that it's more organized and helpful for newcomers:
These changes have been mostly taken from Quarkus CONTRIBUTING.md and LibreOffice Easy Hacks