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 a few dev guide based on observations #6449

Merged
merged 3 commits into from
Apr 16, 2024

Conversation

BionIT
Copy link
Collaborator

@BionIT BionIT commented Apr 14, 2024

Description

This change adds a few dev guides based on observations when reviewing PRs, and the intent is to use current guide to illustrate the best practice and a reference for contributors.

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

Signed-off-by: Lu Yu <nluyu@amazon.com>
Signed-off-by: Lu Yu <nluyu@amazon.com>
continued lines are indented.';
```

#### Avoid using `@ts-ignore`
Copy link
Member

Choose a reason for hiding this comment

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

+1 we should not take shortcut to ignore the warning or error

Copy link
Member

@seraphjiang seraphjiang left a comment

Choose a reason for hiding this comment

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

It is always good to learn how to write elegant code, thanks @BionIT

@zhongnansu
Copy link
Member

could you update the change log?

@BionIT BionIT merged commit 3d91b94 into opensearch-project:main Apr 16, 2024
3 of 4 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 16, 2024
* add a few developer guides based on observations

Signed-off-by: Lu Yu <nluyu@amazon.com>

* add more info

Signed-off-by: Lu Yu <nluyu@amazon.com>

---------

Signed-off-by: Lu Yu <nluyu@amazon.com>
(cherry picked from commit 3d91b94)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
BionIT pushed a commit that referenced this pull request Apr 16, 2024
* add a few developer guides based on observations



* add more info



---------


(cherry picked from commit 3d91b94)

Signed-off-by: Lu Yu <nluyu@amazon.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>
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.

4 participants