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

doc : Improve our CONTRIBUTING guide from a newcomer perspective #89

Merged

Conversation

rohanKanojia
Copy link
Member

@rohanKanojia rohanKanojia commented May 15, 2024

Updated contributing guide so that it's more organized and helpful for newcomers:

  • Added table of contents
  • Added information about good first issues and first timers only issues
  • Added information about how to build project and use local build of plugins (both maven and gradle)
  • Added information about how to debug project
  • Added information about how to generate project documentation

These changes have been mostly taken from Quarkus CONTRIBUTING.md and LibreOffice Easy Hacks

@rohanKanojia rohanKanojia marked this pull request as ready for review May 15, 2024 12:51
@rohanKanojia rohanKanojia requested review from manusa and sunix May 15, 2024 13:08
@manusa
Copy link
Member

manusa commented May 15, 2024

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:
These issues are aimed for first-time contributors to get acquainted with the project and the Eclipse Foundation contributing policies.
Users are only allowed to take one of these issues and are also encouraged to tackle one of these before doing more complex code contributions.
These issues are extremely simple to solve. In general, the code changes are already described in the issue.
The main purpose is to ensure that contributors have signed an ECA and are familiar with the GitHub pull request procedures.

good-first-issue:
These issues are aimed for users who have already tackled a first-timers-only and would like to continue their contributing journey on the project.
These issues are slightly more complicated and will require actual work from the contributor.
The main purpose is for contributors to gain confidence while working on the code-base and to keep them engaged in the project.

help-wanted:
These issues are more complex and are aimed for regular contributors of the project or people who are familiar with the code-base.

@rohanKanojia
Copy link
Member Author

Shall I add abovementioned paragraphs in Finding an issue to work on section?

@@ -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)
Copy link
Member

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

@manusa
Copy link
Member

manusa commented May 15, 2024

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: These issues are aimed for first-time contributors to get acquainted with the project and the Eclipse Foundation contributing policies. Users are only allowed to take one of these issues and are also encouraged to tackle one of these before doing more complex code contributions. These issues are extremely simple to solve. In general, the code changes are already described in the issue. The main purpose is to ensure that contributors have signed an ECA and are familiar with the GitHub pull request procedures.

good-first-issue: These issues are aimed for users who have already tackled a first-timers-only and would like to continue their contributing journey on the project. These issues are slightly more complicated and will require actual work from the contributor. The main purpose is for contributors to gain confidence while working on the code-base and to keep them engaged in the project.

help-wanted: These issues are more complex and are aimed for regular contributors of the project or people who are familiar with the code-base.

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.

@rohanKanojia
Copy link
Member Author

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
Copy link
Member

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have added this sentence:

Screenshot_20240517_092134

@manusa
Copy link
Member

manusa commented May 15, 2024

Shall we split this page into multiple small pages?

I don't think that's a good idea.

@rohanKanojia rohanKanojia force-pushed the pr/contributing-guide-improvements branch from 8bb5be9 to 67d8098 Compare May 15, 2024 16:59
Copy link
Member

@manusa manusa left a 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 🚀

@rohanKanojia rohanKanojia force-pushed the pr/contributing-guide-improvements branch from 67d8098 to dda14ba Compare May 27, 2024 03:35
@manusa manusa merged commit 35c7681 into eclipse-jkube:main May 28, 2024
2 checks passed
@rohanKanojia rohanKanojia deleted the pr/contributing-guide-improvements branch May 28, 2024 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants