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

Improve our CONTRIBUTING guide from a newcomer perspective #2961

Open
1 task
rohanKanojia opened this issue Apr 24, 2024 · 0 comments
Open
1 task

Improve our CONTRIBUTING guide from a newcomer perspective #2961

rohanKanojia opened this issue Apr 24, 2024 · 0 comments
Assignees
Labels
help wanted Extra attention is needed

Comments

@rohanKanojia
Copy link
Member

rohanKanojia commented Apr 24, 2024

Component

None

Task description

Description

Our CONTRIBUTING guide needs to be improved so that newcomers get a better idea of what to do and how to get started after reading it. In my opinion, this task can only be done by someone new to the project. At the moment, I see these issues:

  • There is no information about which issues are suitable for newcomers. We have first-timers-only labeled issues for people contributing for the first time and help wanted labeled issues for contributors who have gone past their first contributions.
  • There is no information about how to build the project and use the local build in some quickstart. This includes Running mvn clean install -DskipTests and pointing any quickstart to SNAPSHOT version .
  • There is no information about how to debug plugin, using mvnDebug for maven and gradle -Dorg.gradle.debug=true on Gradle while debugging Kubernetes/OpenShift plugins needs to be specified.
  • Many contributors are using Windows and face JUnit Testcases failing while building the project in windows #1338 , it needs to be specified in CONTRIBUTING guide to use -DskipTests while building on Windows

Here is a better example of CONTRIBUTING guide:

The source for CONTRIBUTING guide is located here: https://github.com/eclipse-jkube/jkube-website/blob/main/src/content/contributing/index.mdx

Expected Behavior

The contributing guide is improved for newcomers

Acceptance Criteria

  • Contributing guide is improved and abovementioned points are added
@rohanKanojia rohanKanojia added the help wanted Extra attention is needed label Apr 24, 2024
@rohanKanojia rohanKanojia self-assigned this May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant