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

Latest commit

 

History

History
74 lines (50 loc) · 4.69 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 4.69 KB
Raw

Contributing Guidelines

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

How to Contribute on Klaytn Docs

  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 master branch, and following the successful build, the suggested content change could be previewed with GitBook preview feature (clicking Details under Show all checks).
  8. Once the change has been approved, the PR is merged by the project moderator.
  9. After merging the PR, the pull request will be closed. You can then delete the now obsolete branch.
  10. https://docs.klaytn.foundation/ will be updated with the suggested changes (merged content).

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 Typos

If you could identify issues and typos in Klaytn docs, 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 covered in the latest release of Klaytn Docs.
  • The issue covers minor typos or errors on the existing content of Klaytn Docs. Please do not use the issue tracker for personal support requests. Use developer@klaytn.com for the personal support requests.

After confirming your report meets the above criteria, submit the issue. Please use labels to specify your issue as issues-and-typos.

Content Contribution

If you would recommend major content change in Klaytn docs, 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 covered in the latest release of Klaytn Docs.
  • The issue covers major content change (e.g. Adding/removing paragraph and chapter in Klaytn Docs, adding/removing graphical explanation, etc.) on the existing content of Klaytn Docs. Please do not use the issue tracker for personal support requests. Use developer@klaytn.com for the personal support requests.

After confirming your report meets the above criteria, submit the issue. Please use labels to specify your issue as content-contribution.

Usage of Labels

You can use the following labels:

Labels for initial issue categories:

  • issue/issues-and-typos: Issues with the minor content typos and inaccuracy.
  • issue/content-contribution: Issues with major content contributions.

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 issues-and-typos or future content-contribution.
  • open/contribution welcome: The content fix or update 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 is not applicable to the Klaytn Docs.
  • closed/reject: The issue is rejected after review.

Contributor License Agreement (CLA)

Keep in mind when you submit your pull request, you'll need to sign the CLA via CLA-Assistant 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.