Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

Latest commit

 

History

History
98 lines (63 loc) · 5.79 KB

CONTRIBUTING.md

File metadata and controls

98 lines (63 loc) · 5.79 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to Klaytn Organization. As an open source project, Klaytn Organization is always open to the developer community and we welcome your contribution to help more developer onboarding resources for the Klaytn developer community. Please read the guideline below and follow it in all interactions with the project.

How to Contribute on Klaytn

  1. Read this contributing document.
  2. Sign Contributor Licensing Agreement (CLA).
  3. Submit an issue with a proper labelling.
  4. Please wait until the label changes to contribution welcome - otherwise, it is not ready to be worked on.
  5. Only after the label changed to contribution welcome, you can start submitting the changes. To avoid any duplicate efforts, it is recommended to update the issue so that other contributors could see someone working on the issue.
  6. Before making a Pull Request (PR), please make sure the suggested content changes are accurate and linked with the corresponding issue reported. After submitting the PR, wait for code review and approval. The reviewer may ask you for additional commits or changes.
  7. All PRs should be made against the dev branch, once the change has been approved, the PR is merged by the project moderator.
  8. After merging the PR, the pull request will be closed. You can then delete the now obsolete branch.

Types of Contribution

There are various ways to contribute and participate. Please read the guidelines below regarding the process of each type of contribution.

Issues and Bugs

If you find a bug or other issues in Klaytn, please submit an issue. Before submitting an issue, please invest some extra time to figure out that:

  • The issue is not a duplicate issue.
  • The issue has not been fixed in the latest release of klaytn-dex-frontend. Please do not use the issue tracker for personal support requests. Use developer@klaytn.foundation for the personal support requests.

When you report a bug, please make sure that your report has the following information.

  • Steps to reproduce the issue.
  • A clear and complete description of the issue.
  • Code and/or screen captures are highly recommended.

After confirming your report meets the above criteria, submit the issue. Please use labels to categorize your issue.

Feature Requests

You can also use the issue tracker to request a new feature or enhancement. Note that any code contribution without an issue link will not be accepted.

Please submit an issue explaining your proposal first so that the Klaytn developer community can fully understand and discuss the idea. Please use labels for your feature request as well.

Usage of Labels

You can use the following labels:

Labels for initial issue categories:

  • issue/bug: Issues with the code-level bugs.
  • issue/documentation: Issues with the documentation.
  • issue/enhancement: Issues for enhancement requests.

Status of open issues (will be tagged by the project moderators):

  • (no label): The default status.
  • open/need more information : The issue's creator needs to provide additional information to review.
  • open/reviewing: The issue is under review.
  • open/re-label needed: The label needs to be changed to confirmed as being a bug or future enhancement.
  • open/approved: The issue is confirmed as being a bug to be fixed or enhancement to be developed.
  • open/contribution welcome: The fix or enhancement is approved and you are invited to contribute to it.

Status of closed issues:

  • closed/fixed: A fix for the issue was provided.
  • closed/duplicate: The issue is also reported in a different issue and is being managed there.
  • closed/invalid: The issue cannot be reproduced.
  • closed/reject: The issue is rejected after review.

Code Contribution

Please follow the coding style and quality requirements to satisfy the product standards. You must follow the coding style as best as you can when submitting code. Take note of naming conventions, separation of concerns, and formatting rules.

For the coding style of JavaScript, please refer to the following websites:

Before you submit a pull request, please check the README.md to run unit tests, fix formatting to correct any errors. Otherwise, the test on CircleCI will fail, and this prevents merging.

Formatting errors can be easily fixed by running pnpm format:fix.

Tests

  • Tests Must be Written Elegantly

    Tests are a good way to show how to use the library, and maintaining them is extremely necessary. Don't write long tests, write helper functions to make them be as short and concise as possible (they should take just a few lines each), and use good variable names.

  • Tests Must not be Random

    Inputs for tests should not be generated randomly. Accounts used to create test wallets are an exception, those can be random. Also, the type and structure of outputs should be checked.

Contributor License Agreement (CLA)

Keep in mind when you submit your pull request, you'll need to read the CLA document and sign by posting "I have read the CLA Document and I hereby sign the CLA" in the comment of PR for legal purposes. You will have to sign the CLA just one time, either as an individual or corporation.

You will be prompted to sign the agreement by CLA Assistant (bot) when you open a Pull Request for the first time.