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.

Sign up for GitHub

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

Update test2.md #253

Closed
wants to merge 1 commit into from
+87 −0
Closed

Update test2.md #253

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions docs/test2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,90 @@
7. Address review feedback: The reviewer may request additional commits or changes. Be responsive and address their feedback to ensure your contribution aligns with the project's standards.
8. PR merge and branch deletion: Once approved, the project moderator will merge your PR into the main branch. You can then safely delete your working branch.
9. Content update: The Kaia Docs website (https://docs.kaia.io/) will be updated with your merged contribution.

## 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](#issues-and-typos)
- [Content Contribution](#content-contribution)
- [Content Translation](#content-translation)

### Issues and Typos

If you could identify issues and typos in Kaia 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 Kaia Docs.
- The issue covers minor typos or errors on the existing content of Kaia Docs.
Please do not use the issue tracker for personal support requests. Use [email protected] for the personal support requests.

After confirming your report meets the above criteria, [submit the issue](https://github.com/kaiachain/kaia-docs/issues). Please use [labels](#usage-of-labels) to specify your issue as `issues-and-typos`.

### Content Contribution

If you would recommend major content change in Kaia 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 Kaia Docs.
- The issue covers major content change (e.g. Adding/removing paragraph and chapter in Kaia Docs, adding/removing graphical explanation, etc.) on the existing content of Kaia Docs.

Check failure on line 42 in docs/test2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/test2.md#L42 

[Google.Latin] Use 'for example' instead of 'e.g.'.
Raw output 
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/test2.md", "range": {"start": {"line": 42, "column": 42}}}, "severity": "ERROR"}
Please do not use the issue tracker for personal support requests. Use [email protected] for the personal support requests.

After confirming your report meets the above criteria, [submit the issue](https://github.com/kaiachain/kaia-docs/issues). Please use [labels](#usage-of-labels) to specify your issue as `content-contribution`.

### Content Translation

If you are fluent in a language other than English and want to contribute translations or improve the localized documentation, [submit an issue](https://github.com/kaiachain/kaia-docs/issues). Please use [labels](#usage-of-labels) to specify your issue as `content-translation`.

You need to use the [Crowdin](https://crowdin.com/project/kaia-docs) platform to contribute translations. For more information, see the [Internationalization](https://docs.kaia.io/misc/internationalization/) page.

> [!IMPORTANT]
> For content translation, avoid using a pull request to submit changes by modifying the files under the [i18n](https://github.com/kaiachain/kaia-docs/tree/main/i18n) directory directly. </br> </br> Unlike other types of contribution, the translations are managed by Crowdin localization management platform. If a translation is submitted and has been approved in Crowdin, an automated PR will be made to Kaia docs repo. Once the PR is approved and merged by the project moderators, the localized Kaia docs will be updated with the suggested changes (merged content).

Check failure on line 54 in docs/test2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/test2.md#L54 

[Vale.Spelling] Did you really mean 'repo'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'repo'?", "location": {"path": "docs/test2.md", "range": {"start": {"line": 54, "column": 416}}}, "severity": "ERROR"}

## 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.
- issue/content-translation: Issues with content translations.

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`, future `content-contribution`, or `content-translation`.
- 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 Kaia Docs.
- closed/reject: The issue is rejected after review.

## Additional Contribution Guidelines

Here are some additional guidelines to follow when contributing to Kaia Docs:

### Commit Messages

- Start with a capitalized and imperative verb. Examples include "Update", "Fix", "Add", "Improve", etc.

Check failure on line 87 in docs/test2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/test2.md#L87 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "docs/test2.md", "range": {"start": {"line": 87, "column": 66}}}, "severity": "ERROR"}

Check failure on line 87 in docs/test2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/test2.md#L87 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "docs/test2.md", "range": {"start": {"line": 87, "column": 76}}}, "severity": "ERROR"}

Check failure on line 87 in docs/test2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/test2.md#L87 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "docs/test2.md", "range": {"start": {"line": 87, "column": 83}}}, "severity": "ERROR"}

Check failure on line 87 in docs/test2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/test2.md#L87 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "docs/test2.md", "range": {"start": {"line": 87, "column": 90}}}, "severity": "ERROR"}
- Use a consistent format for commit messages. A common pattern is "verb: description of change" (for example, "Update contract addresses for Kaia chain").
- Keep the subject line short and descriptive. It should clearly communicate the scope and focus of the change.

### Build and Dependencies

If your contribution involves adding new code or dependencies, ensure the project continues to build successfully after your changes by running a build command (for example, `npm run build`).

### Image Optimization

- Keep all images optimized and compressed to minimize file size (under 30kb whenever possible). This helps to improve website loading speed and keeps the repository size manageable.
- Consider using tools like [Trimage](https://trimage.org/) to optimize your images.

Check failure on line 98 in docs/test2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/test2.md#L98 

[Vale.Spelling] Did you really mean 'Trimage'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Trimage'?", "location": {"path": "docs/test2.md", "range": {"start": {"line": 98, "column": 30}}}, "severity": "ERROR"}

## Contributor License Agreement (CLA)

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.
Loading