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 developer guide #638

Merged
merged 6 commits into from
May 27, 2024
Merged

Add developer guide #638

merged 6 commits into from
May 27, 2024

Conversation

SamuelCox
Copy link
Contributor

Description

Added a brief developer guide, much in the same form as the python repository. The client code generation part is a stub for now, as I am not sure how that works right now. Please let me know what to put there.

Issues Resolved

Couldn't find any issues for this other than a very old closed one from years ago.

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.

@dblock
Copy link
Member

dblock commented May 7, 2024

Awesome! Link it from README?

@SamuelCox
Copy link
Contributor Author

Awesome! Link it from README?

Will do. Also, I see that the changelog verify step is failing. I assumed I didn't need to change that since I wasn't changing code, should I still put something there?

@Xtansia
Copy link
Collaborator

Xtansia commented May 7, 2024

@SamuelCox Don't worry about the changelog, I've added the skip-changelog label to the PR which bypasses that check for these kinds of PRs

@SamuelCox
Copy link
Contributor Author

SamuelCox commented May 8, 2024

@SamuelCox Don't worry about the changelog, I've added the skip-changelog label to the PR which bypasses that check for these kinds of PRs

Nice, other than the stub for the Client Code Generator, it should be complete now then. If either of you want to advise me what to write in there that would be good, because the command I've left there is from the python repo and doesn't exist.

I've also left a stub on running tests in a specific file actually, I'll sort that out soon

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
@SamuelCox SamuelCox marked this pull request as ready for review May 20, 2024 19:33
@SamuelCox
Copy link
Contributor Author

Believe its failing due to a flaky test currently

@dblock
Copy link
Member

dblock commented May 21, 2024

Believe its failing due to a flaky test currently

Is there an issue opened on this, otherwise would you mind to please do it?

@SamuelCox
Copy link
Contributor Author

Believe its failing due to a flaky test currently

Is there an issue opened on this, otherwise would you mind to please do it?

#653

@Xtansia Xtansia merged commit cdc572f into opensearch-project:main May 27, 2024
43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants