Skip to content

docs: fix vale linting errors #586

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 8 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 Contribution 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.
2 changes: 2 additions & 0 deletions .github/workflows/prettify_code.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ jobs:
- name: Checkout
uses: actions/checkout@v3
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
# This is necessary to ensure that the action works with pull requests
ref: ${{ github.head_ref }}
fetch-depth: 0

Expand Down
34 changes: 17 additions & 17 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ The following are Keploy-specific rules that override or expand on the Google an

### 📌 Capitalization of Core Terms

Some of Keploys core terms may also exist as generic terms in software or technical contexts.
Some of Keploy's core terms may also exist as generic terms in software or technical contexts.
To reduce confusion, **always capitalize Keploy-specific terms** when referring to features or platform components. Generic usage should be lowercase and used sparingly.

✅ **Correct:**

> Next, Normalise the Test case on the Test run details page.
> "Next, Normalise the Test case on the Test run details page."

❌ **Incorrect:**

> Next, normalise the test case on the test run details.
> "Next, normalise the test case on the test run details."

---

Expand All @@ -43,35 +43,35 @@ 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.
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.

✅ Correct:

> Install Keploy
> Create test cases
> "Install Keploy,"
> "Create test cases."

❌ Incorrect:

> Installing Keploy
> Creating test cases
> "Installing Keploy,"
> "Creating test cases."

---

### 🧮 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 All @@ -81,11 +81,11 @@ Use **active voice** instead of passive voice to improve clarity and readability

✅ Correct:

> Keploy records the API calls and generates test cases.
> "Keploy records the API calls and generates test cases."

❌ Incorrect:

> The API calls are recorded and test cases are generated by Keploy.
> "The API calls are recorded and test cases are generated by Keploy."

---

Expand All @@ -99,11 +99,11 @@ Use clear, simple, and **inclusive language**:

✅ Better:

> After installing Go, use the following command to run Keploy.
> "After installing Go, use the following command to run Keploy."

❌ Confusing:

> Assuming GOPATH is set and your binaries are globally linked, execute Keploy.
> "Assuming GOPATH is set and your binaries are globally linked, execute Keploy."

---

Expand All @@ -130,4 +130,4 @@ Use clear, simple, and **inclusive language**:

---

> ✨ _Consistency leads to clarity. Lets keep Keploy documentation clean, helpful, and easy to follow._
> ✨ _Consistency leads to clarity. Let's keep Keploy documentation clean, helpful, and easy to follow._
Empty file removed vale_styles/Google/vocab.txt
Empty file.
132 changes: 128 additions & 4 deletions vale_styles/config/vocabularies/Base/accept.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Kk]eploy
Keploy
GitHub
APIs
Idempotency
Expand Down Expand Up @@ -46,13 +46,11 @@ dockerfile
html
npm
api
API
params
Cmd
respository
Hacktoberfest
wsl
WSL
testsets
Testrun
YAMLs
Expand All @@ -65,4 +63,130 @@ templatize
wiremessages
middleware
distros
url
url
repo
shorteners
mongoDb
Mux
traceroute
args
linux
env
homebrew
debian
Zsh
globbing
sudoers
hardcoded
Wohoo
Prequisites
Reusability
Behat
RSpec
Chai
testng
LLM's
Challeges
Whitebox
ontinuous
PHPUnit
accelrating
anonymized
shopify
performant
param
dedup
js
Whate
invaliduser
wiremessage
http
Autogenerate
searchability
doxing
Contributribution
vale_styles
renametest
eg
subequent
testset
Passthrough
Karaf
litellm
coberuta
dependecies
dommand
KTests
subcommand
yaml
llm
javascript
nyc
Sudo
xml
KTest
yout
worflow
oss
moc
Djangoand
catelog
cli
mins
petclinic
walkthrough
applicaiton
essentailly
VSCode
peformed
openhospital
Openhospital
Intoduction
Sanic
genereate
invalid_user
sublicense
testfile
Surgefire
GMaps
classpath
Intellij
servlets
myApp
denoise
Gitpod
uncommenting
folderj
resonse
ide
inplements
sql
razorpay
exising
Funtional
Idempotence
Octokit
Eslint
ui
respones
enusre
gqlgen
descibe
ngrok
Vet_List_All
sanitization
teardown
Prisma
dev
SLAs
signup
Neovim
DTOs
se
tup
10s
gorm
mongo
hardcoding
async
substring
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Functional testing is a type of software testing that verifies that the software

Functional testing is typically performed by providing the software with input data and then checking the output data to see if it matches the expected results. This can be done manually or using automated testing tools.

### Types of Funtional Testing
### Types of Functional Testing

There are many different types of functional testing, including:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ After you have cloned the documentation repo to your computer locally, edit the

3. On Github, click on the `Create a new Pull Request` button.

4. Use a succinct title and descriptive comments to descibe your Pull Request. Also Ensure maintainers can understand your proposed changes from the description
4. Use a succinct title and descriptive comments to describe your Pull Request. Also Ensure maintainers can understand your proposed changes from the description

## How to Suggest UI/UX Improvements?

Expand Down
12 changes: 1 addition & 11 deletions versioned_docs/version-1.0.0/devtools/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,8 @@ docker-compose -f docker-compose-dev.yaml up --build
```

If you are not using docker, you can build and run the keploy server directly. Ensure to provide the Mongo connection string via the `KEPLOY_MONGO_URI` env variable. And also
enusre that `ENABLE_TEST_EXPORT=false` as by default it is `true` and you will not able to see testcases data in UI so make it `false` if you don't want to export test cases.
ensure that `ENABLE_TEST_EXPORT=false` as by default it is `true` and you will not able to see testcases data in UI so make it `false` if you don't want to export test cases.

```shell
export KEPLOY_MONGO_URI="mongodb://mongo:27017"
export ENABLE_TEST_EXPORT=false
go run cmd/server/main.go
```

Keploy exposes GraphQL API for the frontend based on [gqlgen](https://github.com/99designs/gqlgen). After changing the schema `graph/schema.graphqls` you can autogenerate graphQL handlers `graph/schema.resolvers.go` using

```shell
go generate ./...
```

Note:- As we follow conventional commits so we encourage you to also follow that while making commits. You can know more about them on here
Loading