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

[CCI] Update CONTRIBUTING.md: add entry about good first issue, first PR #7027

Closed

Conversation

Nicksqain
Copy link

@Nicksqain Nicksqain commented Apr 6, 2023

Description

CONTRIBUTING.md update:

  • Link to ONBOARDING
  • Help to create the first pull request
  • Basic git commands

The way I see it, this PR should help newbies who don't know how to work with git. It raises the entry threshold. This is the reference to #6948.

Issues Resolved

#6845

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff
  • Commit changes are listed out in CHANGELOG.md file (See: Changelog)

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.

Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>
Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>
@Nicksqain Nicksqain mentioned this pull request Apr 6, 2023
6 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2023

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE ❕
  • TEST FAILURES:
      1 org.opensearch.action.admin.indices.create.CreateIndexIT.testCreateAndDeleteIndexConcurrently
      1 org.opensearch.action.admin.indices.create.CreateIndexIT.classMethod
      1 org.opensearch.action.admin.cluster.node.tasks.ResourceAwareTasksTests.testTaskResourceTrackingDuringTaskCancellation

@codecov-commenter
Copy link

codecov-commenter commented Apr 6, 2023

Codecov Report

Merging #7027 (560358d) into main (c85d33e) will increase coverage by 0.10%.
Report is 795 commits behind head on main.
The diff coverage is 88.09%.

@@             Coverage Diff              @@
##               main    #7027      +/-   ##
============================================
+ Coverage     70.66%   70.77%   +0.10%     
- Complexity    59231    59302      +71     
============================================
  Files          4812     4813       +1     
  Lines        283761   283762       +1     
  Branches      40917    40917              
============================================
+ Hits         200519   200821     +302     
+ Misses        66784    66485     -299     
+ Partials      16458    16456       -2     
Files Changed Coverage Δ
...a/org/opensearch/plugins/InstallPluginCommand.java 85.14% <ø> (ø)
...rc/main/java/org/opensearch/plugins/PluginCli.java 0.00% <ø> (ø)
...va/org/opensearch/plugins/RemovePluginCommand.java 85.48% <ø> (ø)
...src/main/java/org/opensearch/cli/MultiCommand.java 93.54% <ø> (ø)
...java/org/opensearch/common/collect/MapBuilder.java 66.66% <ø> (ø)
...in/java/org/opensearch/common/util/io/IOUtils.java 83.33% <ø> (ø)
...in/java/org/opensearch/common/util/io/Streams.java 94.11% <ø> (ø)
.../java/org/opensearch/common/util/net/NetUtils.java 68.75% <ø> (ø)
.../src/main/java/org/opensearch/core/Assertions.java 75.00% <ø> (ø)
...currency/OpenSearchRejectedExecutionException.java 100.00% <ø> (ø)
... and 139 more

... and 432 files with indirect coverage changes

@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2023

Gradle Check (Jenkins) Run Completed with:

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

I feel pretty strongly that this belongs in https://github.com/opensearch-project/.github/blob/main/ONBOARDING.md, and that it's not our job here to teach folks the basics of git. Can we link a section to ONBOARDING about git below the GitHub one, and link a good external tutorial instead?

@Nicksqain
Copy link
Author

@dblock I'm sorry, but if so, can this git guide be added to the forum and somehow leave a link?

@dblock
Copy link
Member

dblock commented Apr 6, 2023

@dblock I'm sorry, but if so, can this git guide be added to the forum and somehow leave a link?

You should just post it somewhere and I am a maybe on a link to a forum because there's a million existing tutorials for git and because yours only works for some people (for example Ctrl + Shift + G isn't something that works on my mac). This way I point people to https://docs.github.com/en/get-started/quickstart or the million other tutorials for git that will be there for a long time. Maybe other maintainers feel otherwise.

@kotwanikunal kotwanikunal added the CCI College Contributor Initiative related issues and PRs label Apr 12, 2023
@opensearch-trigger-bot
Copy link
Contributor

This PR is stalled because it has been open for 30 days with no activity. Remove stalled label or comment or this will be closed in 7 days.

@opensearch-trigger-bot opensearch-trigger-bot bot added the stalled Issues that have stalled label Jun 26, 2023
@opensearch-trigger-bot
Copy link
Contributor

This PR was closed because it has been stalled for 7 days with no activity.

@kotwanikunal
Copy link
Member

Apologies. This PR was auto closed without reaching a resolution from the maintainers.
Re-opening to move it forward.
Thanks for your contributions to OpenSearch!

@github-actions
Copy link
Contributor

Compatibility status:

Checks if related components are compatible with change 560358d

Incompatible components

Skipped components

Compatible components

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

I like the part that references ONBOARDING, but I don't love the rest. This doc should have mostly OpenSearch core-specific things, and this is one massive repo to start contributing in "small stuff".

I'd remove all the parts about learning git, and making a first PR into any repo from here. I'd want to direct users to ONBOARDING, which itself should be directing users to https://docs.github.com/en/get-started/quickstart/github-flow.

@peternied
Copy link
Member

I agree with @dblock assessment, being that this pull request has stalled for a considerable amount of time and the issue associated [1] with it was resolved as not planned, I'm closing out this pull request.

@peternied peternied closed this Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCI College Contributor Initiative related issues and PRs stalled Issues that have stalled
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants