Merge pull request #229 from scott-klaytn/cla-improvement

Improve CLA signing process

.github/CLA.md

@@ -0,0 +1,30 @@
+# Contributor License Agreement
+
+> [!IMPORTANT]
+> To sign this CLA, please do the steps below:
+> 1. Read the entire document below.
+> 2. Return to your Pull Request.
+> 3. Add a comment with exactly: "I have read the CLA Document and I hereby sign the CLA".
+> 4. Wait for the automated check to pass after the PR is submitted.
+
+Thank you for your contribution to the Kaia Docs project. In order to clarify the intellectual property rights in the project, and to grant licenses to the project to others, Kaia requires that you accept this Contributor License Agreement (“Agreement”). This license is for your protection as a Contributor as well as the protection of Kaia, its users, and its licensees; you may still license your own Contributions under other terms.
+
+You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Kaia. Except for the license granted herein to Kaia and recipients of software distributed by Kaia, You reserve all right, title, and interest in and to Your Contributions. This Agreement is based on the Twitter CLA available here.
+
+1. Definitions.
+“You” (or “Your”) shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Kaia. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, “control” means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.  
+“Contribution” shall mean any original work of authorship or invention, including any modifications or additions to an existing work, that is intentionally submitted by You to Kaia for inclusion in, or documentation of, any of the products owned or managed by Kaia (the “Work”). For the purposes of this definition, “submitted” means any form of electronic, verbal, or written communication sent to Kaia or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Kaia for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Contribution.”
+
+2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Kaia and to recipients of software distributed by Kaia a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute Your Contributions and such derivative works, as well as the right to sublicense and have sublicensed all of the foregoing rights, through multiple tiers of sublicensees.
+
+3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Kaia and to recipients of software distributed by Kaia a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that Your Contribution, or the Work to which You have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+
+4. You represent that You are legally entitled to grant the above license. If Your employer(s) has rights to intellectual property that You create that includes Your Contributions, You represent that You have received permission to make Contributions on behalf of that employer, that Your employer has waived such rights for Your Contributions to Kaia, or that Your employer has executed with Kaia a separate contributor license agreement substantially similar to this Agreement.
+
+5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which You are personally aware and which are associated with any part of Your Contributions.
+
+6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of title, non-infringement, merchantability, or fitness for a particular purpose.
+
+7. You may submit work that is not Your original creation (“Third-Party Creation”) subject to the following guidelines: (i) the Third-Party Creation must be submitted to Kaia separately from any Contribution; (ii) when submitting a Third-Party Creation You must sufficiently identify the details of its source; (iii) when submitting a Third-Party Creation You must identify any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which You are aware; and (iv) the Third-Party Creation must be conspicuously marked, for example, writing comments on PR message or code comment, with the following legend - "Submitted on behalf of a third-party: [insert third-party named here]."
+
+8. You agree to notify Kaia of any facts or circumstances of which You become aware that would make these representations inaccurate in any respect.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,29 +1,40 @@
-## Proposed changes
+## ✨ Proposed Changes
 
-- Describe your changes to communicate to the maintainers why we should accept this pull request.
-- If it fixes a bug or resolves a feature request, be sure to link to that issue.
+<!-- Describe your changes to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.-->
 
-## Types of changes
+-
+-
 
-Please put an x in the boxes related to your change.
+## 🗂️ Types of changes
+
+<!-- Please put an x in the boxes related to your change (i.e. [x]).-->
 
 - [ ] Minor Issues and Typos
 - [ ] Major Content Contribution
-- [ ] Others
+- [ ] Others (e.g. platform-specific changes)
+
+## 🔒 CLA requirements - FIRST-TIME CONTRIBUTORS only 📝
+
+**Welcome!** Before we can review your PR, there's one important step:
+
+1. **Read** our [Contributor License Agreement](https://github.com/kaiachain/kaia-docs/blob/main/.github/CLA.md).
+2. **Sign** by commenting **exactly** this in the PR: ```I have read the CLA Document and I hereby sign the CLA```
+
+🔍 **Why This Matters:** This protects both you and the project, ensuring everyone can safely use your contributions. Without CLA signing, we can't merge your PR. Thank you for your understanding!
+
+## ✅ Checklist
 
-## Checklist
+<!-- Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to reach out. We're here to help! This is simply a reminder of what we are going to look for before merging your code. -->
 
-*Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to reach out. We're here to help! This is simply a reminder of what we are going to look for before merging your code.*
+- [ ] I have read the [CONTRIBUTING GUIDELINES](https://github.com/kaiachain/kaia-docs/blob/main/CONTRIBUTING.md).
+- [ ] I have added necessary documentation (if appropriate).
+- [ ] Any dependent changes have been merged and published in downstream modules.
 
-- [ ] I have read the [CONTRIBUTING GUIDELINES](https://github.com/kaiachain/kaia-docs/blob/main/CONTRIBUTING.md)
-- [ ] I have read the [CLA](https://gist.github.com/kaiachain-dev/bbf65cc330275c057463c4c94ce787a6) and signed by comment ```I have read the CLA Document and I hereby sign the CLA``` in first time contribute
-- [ ] I have added necessary documentation (if appropriate)
-- [ ] Any dependent changes have been merged and published in downstream modules
+## 📌 Related issues
 
-## Related issues
+<!-- Please leave the issue numbers or links related to this PR here something like `Fixes #1234` or `Related to #1234`. -->
 
-- Please leave the issue numbers or links related to this PR here.
 
-## Further comments
+## 💡 Further comments
 
-If this is a relatively large content contribution, kick off the discussion by explaining why you would suggest the content contribution, etc...
+<!-- If this is a relatively large content contribution, kick off the discussion by explaining why you would suggest the content contribution, etc... -->

style-guide.md → .github/style-guide.md

@@ -1,6 +1,6 @@
-# Klaytn Docs Style Guide
+# Kaia Docs Style Guide
 
-Please refer to this style guide when you contribute to Klaytn Docs.
+Please refer to this style guide when you contribute to Kaia Docs.
 
 ## Ground rules
 
@@ -17,7 +17,7 @@ Use clear language, while maintaining technical accuracy. Replace technical jarg
 
 ### Be aware of your audience
 
-Always consider Klaytn users' needs and help them complete processes quickly and easily. Do this by including all steps in procedures, suggesting best practices, and including tips and other types of notes.
+Always consider Kaia users' needs and help them complete processes quickly and easily. Do this by including all steps in procedures, suggesting best practices, and including tips and other types of notes.
 
 ### Get to the point
 
@@ -51,7 +51,7 @@ Use sentence-style capitalization in all levels of headings.
 
 Use the present tense and active voice.
 
-### Klaytn conventions
+### Kaia conventions
 
-- KLAY is always capitalized. There is no plural form. (2 KLAY)
-- Klaytn is written in sentence case.
+- KAIA is always capitalized. There is no plural form. (2 KAIA)
+- Kaia is written in sentence case.

.github/workflows/CLA.yml

@@ -17,7 +17,7 @@ jobs:
           PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_PERSONAL_ACCESS_TOKEN }}
         with:
           path-to-signatures: "${{ github.event.repository.name }}/signatures/version1/cla.json"
-          path-to-document: "https://gist.github.com/kaiachain-dev/bbf65cc330275c057463c4c94ce787a6" # Kaia Gist
+          path-to-document: "https://github.com/kaiachain/kaia-docs/blob/main/.github/CLA.md"
           branch: "main"
           allowlist: dependabot[bot],kaia-docs
           remote-repository-name: ${{ secrets.CLA_REPOSITORY }}

CONTRIBUTING.md

@@ -99,6 +99,4 @@ If your contribution involves adding new code or dependencies, ensure the projec
 
 ## Contributor License Agreement (CLA)
 
-Keep in mind when you submit your pull request, you'll need to sign the CLA via [CLA-Assistant](https://cla-assistant.io/klaytn/klaytn-docs) for legal purposes. You will have to sign the CLA just one time, either as an individual or corporation.
-
-You will be also prompted to sign the agreement by CLA Assistant (bot) when you open a Pull Request for the first time. Post the comment "I have read the CLA Document and I hereby sign the CLA" in the PR.
+Keep in mind when you submit your first pull request, you'll need to sign the CLA by posting the comment "I have read the CLA Document and I hereby sign the CLA" in the PR. You will have to sign the CLA just one time, either as an individual or corporation.