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

Add Contributor Guidelines, User Guide, and Pull Request Template #425

Merged
merged 8 commits into from
Oct 3, 2024

Conversation

IanHoang
Copy link
Collaborator

@IanHoang IanHoang commented Sep 27, 2024

Description

For the last few months, there's been some confusion about contributing to the workloads repository. This PR streamlines the process and adds details related to how to contribute to the workloads repository, establishes new PR best practices, and how to backport changes appropriately.

Issues Resolved

#419
opensearch-project/opensearch-benchmark#583 (comment)

Backport to Branches:

  • 6
  • 7
  • 1
  • 2
  • 3

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: Ian Hoang <ianhoang16@gmail.com>
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
@IanHoang IanHoang added backport 2 Backport to the "2" branch backport 1 backport 3 Backport to the "3" branch backport 7 Backport to the "7" branch ES 6 Backport to Elasticsearch 6.X branch labels Sep 27, 2024
@IanHoang IanHoang changed the title Simplify README and add Contributor Guidelines and User Guide Add Contributor Guidelines, User Guide, and Pull Request Template Sep 27, 2024
Copy link
Member

@OVI3D0 OVI3D0 left a comment

Choose a reason for hiding this comment

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

IMO this guide is very useful, and would really help someone who is new to the workloads repository (like myself) to get up and running without much confusion. Thanks for this!

CONTRIBUTING.md Outdated Show resolved Hide resolved
USER_GUIDE.md Show resolved Hide resolved
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
USER_GUIDE.md Outdated Show resolved Hide resolved
USER_GUIDE.md Show resolved Hide resolved
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
@IanHoang IanHoang requested a review from gkamat October 2, 2024 18:16
@IanHoang IanHoang merged commit 6c2d9cb into opensearch-project:main Oct 3, 2024
2 checks passed
@IanHoang IanHoang deleted the update-readme branch October 3, 2024 15:30
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 3, 2024
* Update README, add contributing guide and user guide.

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates 2

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Update Pull Request Template to include backport branches

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Address feedback from Michael

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Add improvements

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

---------

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
(cherry picked from commit 6c2d9cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 3, 2024
* Update README, add contributing guide and user guide.

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates 2

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Update Pull Request Template to include backport branches

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Address feedback from Michael

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Add improvements

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

---------

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
(cherry picked from commit 6c2d9cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 3, 2024
* Update README, add contributing guide and user guide.

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates 2

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Update Pull Request Template to include backport branches

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Address feedback from Michael

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Add improvements

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

---------

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
(cherry picked from commit 6c2d9cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot
Copy link

The backport to 7 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-7 7
# Navigate to the new working tree
pushd ../.worktrees/backport-7
# Create a new branch
git switch --create backport/backport-425-to-7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 6c2d9cb46ce8125148dbb67ed8c1e752cad53e6b
# Push it to GitHub
git push --set-upstream origin backport/backport-425-to-7
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-7

Then, create a pull request where the base branch is 7 and the compare/head branch is backport/backport-425-to-7.

IanHoang pushed a commit that referenced this pull request Oct 3, 2024
…) (#441)

* Update README, add contributing guide and user guide.



* More updates



* More updates



* Updates



* Updates 2



* Update Pull Request Template to include backport branches



* Address feedback from Michael



* Add improvements



---------


(cherry picked from commit 6c2d9cb)

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang pushed a commit that referenced this pull request Oct 3, 2024
…) (#442)

* Update README, add contributing guide and user guide.



* More updates



* More updates



* Updates



* Updates 2



* Update Pull Request Template to include backport branches



* Address feedback from Michael



* Add improvements



---------


(cherry picked from commit 6c2d9cb)

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang pushed a commit that referenced this pull request Oct 3, 2024
…) (#440)

* Update README, add contributing guide and user guide.



* More updates



* More updates



* Updates



* Updates 2



* Update Pull Request Template to include backport branches



* Address feedback from Michael



* Add improvements



---------


(cherry picked from commit 6c2d9cb)

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang added a commit to IanHoang/opensearch-benchmark-workloads that referenced this pull request Oct 3, 2024
…ensearch-project#425)

* Update README, add contributing guide and user guide.

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates 2

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Update Pull Request Template to include backport branches

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Address feedback from Michael

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Add improvements

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

---------

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
IanHoang added a commit that referenced this pull request Oct 3, 2024
…) (#443)

* Update README, add contributing guide and user guide.



* More updates



* More updates



* Updates



* Updates 2



* Update Pull Request Template to include backport branches



* Address feedback from Michael



* Add improvements



---------

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
joshpalis pushed a commit to joshpalis/opensearch-benchmark-workloads that referenced this pull request Dec 18, 2024
…ensearch-project#425)

* Update README, add contributing guide and user guide.

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* More updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Updates 2

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Update Pull Request Template to include backport branches

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Address feedback from Michael

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

* Add improvements

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>

---------

Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1 backport 2 Backport to the "2" branch backport 3 Backport to the "3" branch backport 7 Backport to the "7" branch ES 6 Backport to Elasticsearch 6.X branch
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants