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

Adding developer guide #471

Merged

Conversation

martin-gaievski
Copy link
Member

@martin-gaievski martin-gaievski commented Oct 25, 2023

Description

Adding developer guide for the repo, this should help onboard new contributors faster.

Issues Resolved

#439

Check List

  • All tests pass
  • Commits are signed as per the DCO using --signoff

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.

@martin-gaievski martin-gaievski added backport 2.x Label will add auto workflow to backport PR to 2.x branch Maintenance Add support for new versions of OpenSearch/Dashboards from upstream skip-changelog labels Oct 25, 2023
@codecov
Copy link

codecov bot commented Oct 25, 2023

Codecov Report

Merging #471 (37da725) into main (0f73cc6) will decrease coverage by 0.20%.
Report is 2 commits behind head on main.
The diff coverage is n/a.

❗ Current head 37da725 differs from pull request most recent head 4955195. Consider uploading reports for the commit 4955195 to get more accurate results

@@             Coverage Diff              @@
##               main     #471      +/-   ##
============================================
- Coverage     84.56%   84.37%   -0.20%     
- Complexity      449      498      +49     
============================================
  Files            38       40       +2     
  Lines          1348     1491     +143     
  Branches        201      228      +27     
============================================
+ Hits           1140     1258     +118     
- Misses          120      133      +13     
- Partials         88      100      +12     

see 9 files with indirect coverage changes

@martin-gaievski
Copy link
Member Author

@ArnoldTingSu I know you were setting up the plugin recently, feel free to check and add what's missing

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
Signed-off-by: Martin Gaievski <[email protected]>
Copy link
Member

@ryanbogan ryanbogan left a comment

Choose a reason for hiding this comment

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

LGTM!

@martin-gaievski martin-gaievski merged commit c3e336f into opensearch-project:main Oct 25, 2023
14 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 25, 2023
* Adding development guide readme file

Signed-off-by: Martin Gaievski <[email protected]>
(cherry picked from commit c3e336f)
martin-gaievski added a commit that referenced this pull request Oct 25, 2023
* Adding development guide readme file

Signed-off-by: Martin Gaievski <[email protected]>
(cherry picked from commit c3e336f)

Co-authored-by: Martin Gaievski <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Label will add auto workflow to backport PR to 2.x branch Maintenance Add support for new versions of OpenSearch/Dashboards from upstream skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants