-
Notifications
You must be signed in to change notification settings - Fork 71
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
Conversation
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>
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.
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!
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
* 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>
* 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>
* 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>
The backport to
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 |
…) (#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>
…) (#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>
…) (#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>
…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>
…) (#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>
…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>
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:
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.