Skip to content

docs: fix the linters for the version3 #611

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.

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .github/CLA.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ You accept and agree to the following terms and conditions for Your present and

2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.

3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" 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.
3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" 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 Contributions alone or by combination of Your Contributions with the Work to which such Contributions was submitted.

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 "Keploy", or that your employer has executed a separate Contributor License Agreement with "Keploy".
4. You represent that you are legally entitled to grant the above license. If your employers 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 "Keploy", or that your employer has executed a separate Contributor License Agreement with "Keploy".

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. 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. Should You wish to submit work that is not Your original creation, You may submit it to "Keploy" separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
7. Should You wish to submit work that is not Your original creation, You may submit it to "Keploy" separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]."

8. You agree to notify "Keploy" of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
12 changes: 6 additions & 6 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ Use **sentence case** for all titles and headings. This means only the **first w

### 🧾 Infinitive Verb Forms in Headings

Use **infinitive verb forms** (e.g., "to install", "to create", "to configure") in titles and headings.
This improves searchability and aligns with common SEO practices.
Use **infinitive verb forms** (e.g., "to install," "to create," "to configure") in titles and headings.
This improves search ability and aligns with common SEO practices.

✅ Correct:

Expand All @@ -60,18 +60,18 @@ This improves searchability and aligns with common SEO practices.

### 🧮 En Dashes in Ranges

Use **en dashes ()** to indicate numeric ranges. Do **not** mix styles or use hyphens inconsistently.
You may also use words like _from_, _to_, or _through_but be consistent throughout the doc.
Use **en dashes ()** to indicate numeric ranges. Do **not** mix styles or use hyphens inconsistently.
You may also use words like _from_, _to_, or _through_but be consistent throughout the doc.

✅ Correct:

- 510 GB
- 510 GB
- 5 to 10 GB

❌ Incorrect:

- from 5-10 GB
- 510 GB and 10 to 20 MB (mixed style)
- 510 GB and 10 to 20 MB (mixed style)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/hacktoberfest/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you’ve ever wanted to contribute to open source, now is your chance! You ca

Anyone around the globe who desires to help drive the growth of open source and make positive contributions to an ever-growing community. All backgrounds and skill levels are encouraged to participate.

- Code Contributribution to Keploy Projects includes:
- Code Contribution to Keploy Projects includes:

- Bug fixes
- New features
Expand Down
77 changes: 76 additions & 1 deletion vale_styles/config/vocabularies/Base/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,81 @@ testmode
timeFreezing
templatize
wiremessages
oss
Ktest
Sanic
middleware
distros
url
url
KTests
sudo
cli
mongoDB
Prisma
walkthrough
VScode
essentially
openhospital
yaml
Mux
Javascript
Neovim
traceroute
repo
DTOs
sanitization
args
linux
env
homebrew
Zsh
debian
hardcoded
Behat
Reusability
LLM's
RSpec
Chai
anonymized
PHPUnit
shopify
param
performant
js
dedup
invaliduser
Autogenerate
eg
http
dev
Ngrok
Karaf
subequent
renametest
SLAs
hardcoding
signup
nyc
subcommand
xml
mins
globbing
Passthrough
async
substring
llm
shorteners
matchType
anonymization
Jira
interdependencies
teardown
protobuf
protoc
Unary
RPCs
viewport
Gradle
sublicense
doxing
vale_styles
2 changes: 1 addition & 1 deletion versioned_docs/version-3.0.0/ci-cd/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Keploy can be integrated with GitHub by two methods:-

## Shell Scripts

GitHub scripts are the easiest way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. You can either add the following script to yout `github workflow` or create a new worflow `.github/workflows/keploy-test.yml`:-
GitHub scripts are the easiest way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. You can either add the following script to your `github workflow` or create a new workflow `.github/workflows/keploy-test.yml`:-

```yaml
- name: Checkout Commit
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-3.0.0/ci-cd/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ In your `.gitlab-ci.yml file`, in last step we have `keploy test` command to run

Did you notice some weird stuff in the pipeline? Like `kmod`, `linux-headers`, `/sys/kernel/debug`...and thought, _"Wait, am I hacking the kernel or something?"_ 😅

Don’t worrythese are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior.
Don’t worrythese are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior.

So we install `kmod`, `linux-headers-generic`, and `bpfcc-tools` to make that tracing possible.

Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs`it’s like giving Keploy the **backstage pass** it needs to watch your app in action.
Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs`it’s like giving Keploy the **backstage pass** it needs to watch your app in action.

No black magic. Just some low-level Linux stuff helping your tests run like magic! 🪄✨

Expand Down Expand Up @@ -145,6 +145,6 @@ Integrating Keploy with GitLab CI automates the testing process, ensuring that t

### 📦 Need the Full Pipeline?

If you’re thinking, “This pipeline looks cool, but I need the _whole thing_ to integrate with your application!”well, you're in luck! Check it out [here](https://github.com/keploy/samples-python) and get ready to copy-paste your way to success! ✨🚀
If you’re thinking, “This pipeline looks cool, but I need the _whole thing_ to integrate with your application!”well, you're in luck! Check it out [here](https://github.com/keploy/samples-python) and get ready to copy-paste your way to success! ✨🚀

Hope this helps you out, if you still have any questions, reach out to us .
4 changes: 2 additions & 2 deletions versioned_docs/version-3.0.0/ci-cd/jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,11 @@ pipeline {

Did you notice some weird stuff in the pipeline? Like `kmod`, `linux-headers`, `/sys/kernel/debug`...and thought, _"Wait, am I hacking the kernel or something?"_ 😅

Don’t worrythese are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior.
Don’t worrythese are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior.

So we install `kmod`, `linux-headers-generic`, and `bpfcc-tools` to make that tracing possible.

Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs`it’s like giving Keploy the **backstage pass** it needs to watch your app in action.
Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs`it’s like giving Keploy the **backstage pass** it needs to watch your app in action.

No black magic. Just some low-level Linux stuff helping your tests run like magic! 🪄✨

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-3.0.0/concepts/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Flags:
Use "keploy [command] --help" for more information about a command.
```

🎉 Wohoo! You are all set to use Keploy.
🎉 Woohoo! You are all set to use Keploy.

## Other Installation Methods

Expand Down Expand Up @@ -98,7 +98,7 @@ alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-networ

### Downloading and running Keploy in Native

**Prequisites:**
**Prerequisites:**

- Linux Kernel version 5.15 or higher
- Run `uname -a` to verify the system architecture.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This testing approach is essential for several reasons:
5. **Detection of Defects**: Identifies functional errors, security vulnerabilities, and performance bottlenecks.
6. **Accessibility**: Suitable for testers with diverse backgrounds and skill sets, adaptable to various software applications.

## Whate are types of Black-Box Testing Techniques ?
## What are types of Black-Box Testing Techniques ?
Copy link
Preview

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

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

Remove the space before the question mark ('Techniques?') and correct header grammar.

Suggested change
## What are types of Black-Box Testing Techniques ?
## What are the Types of Black-Box Testing Techniques?

Copilot uses AI. Check for mistakes.


![How Black Box testing Works?](https://keploy-devrel.s3.us-west-2.amazonaws.com/thumbnail_Black-box.jpg)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Testing your code in small parts does not have to be complex. Here are the steps

## Types of Software Component Testing

![Typinge of Component test](/img/glossary/types-of-component-testing.webp)
![Types of Component testing](/img/glossary/types-of-component-testing.webp)

Component testing validates separate parts of a given system before integration. This testing generally consists of unit testing, module testing, and program testing.

Expand All @@ -80,7 +80,7 @@ Not entirely, but they are very similar and often confused.
| ------------- | ----------------------------------------- | ---------------------------------------------- |
| What it tests | Smallest parts (functions, methods) | Groups of parts working together (modules) |
| Goal | Check if each small piece works correctly | Check if the combined parts work well together |
| Dependencies | No dependenciestests are isolated | May use stubs or drivers for missing pieces |
| Dependencies | No dependenciestests are isolated | May use stubs or drivers for missing pieces |
| Speed | Very fast | A bit slower, tests bigger parts |
| Example | A sum() function | A payment module |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ The **Defect Management Process (DMP)** is a systematic process of detecting, do

### A proper Defect Management Process involves:

- **Detection**Detecting defects during testing.
- **Logging**Recording defects with detailed information.
- **Prioritization**Prioritizing defects based on severity and impact.
- **Assignment**Assigning the defect to developers.
- **Resolution**Fix implementation.
- **Verification**Testing the fix.
- **Detection**Detecting defects during testing.
- **Logging**Recording defects with detailed information.
- **Prioritization**Prioritizing defects based on severity and impact.
- **Assignment**Assigning the defect to developers.
- **Resolution**Fix implementation.
- **Verification**Testing the fix.

## Why is Defect Management Process Important?

Expand Down Expand Up @@ -224,7 +224,7 @@ Attach a screenshot of the unresponsive login button and a video showing the ste
- Include extra details that might help developers understand the defect better.

**Example:**
\_The issue seems to occur only when the device is in low battery mode.
The issue seems to occur only when the device is in low battery mode.

### Step 8: Review and Revise

Expand All @@ -242,7 +242,7 @@ Good defect management leads to good test management. Platforms like **Keploy**

## Conclusion

In this blog, we covered the fundamentals of **Defect Management in software testing**from defect identification, reporting, tracking, verification, to closure.
In this blog, we covered the fundamentals of **Defect Management in software testing**from defect identification, reporting, tracking, verification, to closure.

By following a disciplined defect management process:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The framework's design philosophy centers around efficiency, type safety, and cr

## Core Architecture and Components

gRPC's architecture consists of several key components that work together to provide a robust communication framework. The Protocol Buffer compiler (protoc) generates code from service definitions, creating strongly-typed interfaces that eliminate runtime errors common in loosely-typed systems.
gRPC`s architecture consists of several key components that work together to provide a robust communication framework. The Protocol Buffer compiler (protoc) generates code from service definitions, creating strongly typed interfaces that eliminate runtime errors common in loosely typed systems.

![gRPC Architecture](/img/glossary/gRPC-architecture.webp)

Expand All @@ -40,7 +40,7 @@ The performance benefits of gRPC become apparent in high-throughput scenarios. P

HTTP/2's multiplexing capabilities eliminate the head-of-line blocking issues that plague HTTP/1.1 connections. Multiple requests can be processed simultaneously over a single connection, reducing the overhead associated with establishing multiple TCP connections. This improvement is especially noticeable in microservices architectures where services frequently communicate with each other.

The strongly-typed nature of Protocol Buffers enables compile-time validation, catching errors early in the development process. This type safety extends to the wire format, ensuring that data corruption during transmission is detected and handled appropriately.
The strongly typed nature of Protocol Buffers enables compile-time validation, catching errors early in the development process. This type safety extends to the wire format, ensuring that data corruption during transmission is detected and handled appropriately.

## Communication Patterns

Expand Down Expand Up @@ -146,7 +146,7 @@ gRPC uses Protocol Buffers' backward compatibility features. You can add new fie

### Is gRPC suitable for mobile applications?

Absolutely. gRPC's efficient binary protocol and HTTP/2 multiplexing make it ideal for mobile environments where bandwidth and battery life are concerns. The smaller message sizes and reduced connection overhead provide significant benefits.
Absolutely. gRPC`s efficient binary protocol and HTTP/2 multiplexing make it ideal for mobile environments where bandwidth and battery life are concerns. The smaller message sizes and reduced connection overhead provide significant benefits.

### What programming languages support gRPC?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ keywords:
- Java
---

Testing remains one of the most critical aspects of software development, yet many developers struggle to implement effective testing strategies. JUnit has emerged as the de facto standard for Java testing, providing a robust framework that enables developers to write reliable, maintainable tests that drive quality throughout the development lifecycle.
Testing remains one of the most critical aspects of software development, yet many developers struggle to implement effective testing strategies. JUnit has emerged as the de-facto standard for Java testing, providing a robust framework that enables developers to write reliable, maintainable tests that drive quality throughout the development lifecycle.

## The Evolution of JUnit

JUnit's journey began in the late 1990s when Kent Beck and Erich Gamma recognized the need for a simple, effective testing framework for Java applications. What started as a lightweight solution has evolved into a comprehensive testing ecosystem that powers millions of applications worldwide.
JUnit's journey began in the late 1990's when Kent Beck and Erich Gamma recognized the need for a simple, effective testing framework for Java applications. What started as a lightweight solution has evolved into a comprehensive testing ecosystem that powers millions of applications worldwide.

The framework's design philosophy centers on simplicity and effectiveness. Rather than overwhelming developers with complex configurations, JUnit provides intuitive annotations and assertions that make test writing straightforward and maintainable. This approach has contributed significantly to its widespread adoption across enterprises of all sizes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Software Testing Life Cycle (STLC) comprises several phases that guide the testi
- **Risk-Based Testing**: Prioritize tests based on potential impact and likelihood of failure.
- **Performance Testing**: Evaluate software performance under various conditions and loads.

## How Keploy helps in accelrating the Software Testing Life Cycle process?
## How Keploy helps in accelerating the Software Testing Life Cycle process?

Keploy enhances the STLC with its advanced features tailored for modern software testing needs:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ JUnit 5 is the next generation of the JUnit framework, introducing new features
### TestNG (Java):

TestNG is another testing framework for Java, designed to cover a broader range of testing categories, including unit, functional, and integration testing. It supports parallel execution, data-driven testing, and easy configuration through annotations.
![testng](../../../../../static/img/glossary/testng.png)
![testing](../../../../../static/img/glossary/testng.png)
Copy link
Preview

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

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

Alt text should accurately describe the image (e.g., 'TestNG logo') to improve accessibility.

Suggested change
![testing](../../../../../static/img/glossary/testng.png)
![TestNG logo](../../../../../static/img/glossary/testng.png)

Copilot uses AI. Check for mistakes.


## Conclusion

Expand Down
Loading
Loading