Skip to content

SDKS-4619 Add CONTRIBUTING.md and simplify README.md#170

Merged
spetrov merged 1 commit intodevelopfrom
SDKS-4619
Mar 17, 2026
Merged

SDKS-4619 Add CONTRIBUTING.md and simplify README.md#170
spetrov merged 1 commit intodevelopfrom
SDKS-4619

Conversation

@witrisna
Copy link
Contributor

@witrisna witrisna commented Mar 16, 2026

JIRA Ticket

SDKS-4619

Description

Key changes:

  • Created CONTRIBUTING.md to provide guidelines on project setup, testing, coding standards, and the pull request process.
  • Streamlined README.md by removing the experimental module list and adding a link to the official documentation.
  • Updated the license section in README.md to point to the project's MIT license file.

@codecov
Copy link

codecov bot commented Mar 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 44.94%. Comparing base (74b0a2f) to head (7695737).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files
@@              Coverage Diff              @@
##             develop     #170      +/-   ##
=============================================
+ Coverage      44.92%   44.94%   +0.02%     
  Complexity      1232     1232              
=============================================
  Files            302      302              
  Lines           9389     9389              
  Branches        1352     1352              
=============================================
+ Hits            4218     4220       +2     
  Misses          4630     4630              
+ Partials         541      539       -2     
Flag Coverage Δ
integration-tests 25.98% <ø> (ø)
unit-tests 26.24% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@spetrov spetrov left a comment

Choose a reason for hiding this comment

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

Approved, with some comments that we may want to consider before proceeding with this...

CONTRIBUTING.md Outdated
```sh
git push origin your-feature-branch
```
5. Open a **Pull Request** to the `main` branch of the original repository.
Copy link
Contributor

Choose a reason for hiding this comment

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

Target branch should be develop, right?

Choose a reason for hiding this comment

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

agree

Copy link

Choose a reason for hiding this comment

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

Echoing Stoyans comments

CONTRIBUTING.md Outdated
```sh
git push origin your-feature-branch
```
5. Open a **Pull Request** to the `main` branch of the original repository.

Choose a reason for hiding this comment

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

agree

CONTRIBUTING.md Outdated
5. Open a **Pull Request** to the `main` branch of the original repository.
6. In your Pull Request, please follow the template provided. This includes:
* **Linking to a JIRA ticket** if applicable.
* Providing a **clear description** of the changes you have made.

Choose a reason for hiding this comment

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

I would say clear description and justfication of the changes made

Key changes:
- Created `CONTRIBUTING.md` to provide guidelines on project setup, testing, coding standards, and the pull request process.
- Streamlined `README.md` by removing the experimental module list and adding a link to the official documentation.
- Updated the license section in `README.md` to point to the project's MIT license file.
@spetrov spetrov merged commit fc7d152 into develop Mar 17, 2026
17 checks passed
@spetrov spetrov deleted the SDKS-4619 branch March 17, 2026 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants