Skip to content

Improve README.md: clarify process, fix typos, and enhance formatting #28

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

Closed
Ritesh17-stack wants to merge 1 commit into from
Closed

Improve README.md: clarify process, fix typos, and enhance formatting #28

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
139 changes: 81 additions & 58 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,115 +1,138 @@
# Keploy Writers Program

<p align="center">
<img align="center" src="https://docs.keploy.io/img/keploy-logo-dark.svg?s=200&v=4" height="40%" width="40%" alt="keploy logo"/>
</p>

<h1 align="center">
<b>
Writers Program
</b>
</h1 >
## Table of Contents
- [About the Program](#about-the-program)
- [How to Submit](#how-to-submit)
- [Eligibility](#eligibility)
- [The Process](#the-process)
- [Technical Writing Guidelines](#technical-writing-guidelines)
- [Rewards](#rewards)
- [Terms and Conditions](#terms-and-conditions)
- [Plagiarism Policy](#plagiarism-policy)
- [Screenshots](#screenshots)
- [FAQs](#faqs)
- [Contact & Support](#contact--support)

At Keploy, we're always looking for new ways for our community to get involved in what we do. Keploy Writer's program is focused to acknowledge the creativity, skills, and talent of various writers in the technical ecosystem, and pay them for writing developer-centric content. Through this program, authors can now either **win swags or earn up to $100** for publishing content with Keploy🧡
---

<p style='font-size: 20px;'> We seek a broad range of technical content from experienced writers to produce content for software developers that provides rich detail about using popular tools. We’re looking for content that targets beginner to intermediate software developers. </p>
## About the Program

Examples of some preferred topics might include:
At Keploy, we're always looking for new ways for our community to get involved. The Keploy Writers Program acknowledges the creativity, skills, and talent of writers in the technical ecosystem, and rewards them for writing developer-centric content. Through this program, authors can **win swags or earn up to $100** for publishing content with Keploy 🧡

<ul style='font-size: 20px; margin-left:100px;'>
<li> Software testing productivity hacks. </li>
<li> Tips and tricks for popular software testing tools. </li>
<li> A case study on testing and testing techniques. </li>
<li> How to perform e2e testing with popular app frameworks like Node, Java, Django, and Flask. </li>
</ul>
We seek a broad range of technical content from experienced writers to produce articles for software developers, especially those targeting beginner to intermediate levels.

## How to submit?
**Preferred topics include:**
- Software testing productivity hacks
- Tips and tricks for popular software testing tools
- Case studies on testing and testing techniques
- How to perform end-to-end (e2e) testing with popular app frameworks like Node, Java, Django, and Flask

If you're a fit for this program, [Write for Us](https://forms.gle/ZP72SpWdNyjg4gbu8) and earn exciting rewards and compensation by Keploy🧡
---

## About you
## How to Submit

We are seeking individuals who meet the following eligibility criteria:
If you're interested in this program, [Write for Us](https://forms.gle/ZP72SpWdNyjg4gbu8) and earn exciting rewards and compensation by Keploy 🧡

<ul style='font-size: 20px; margin-left:100px;'>
<li> Experience in Technical Writing. </li>
<li> Decent knowledge in the tech domain </li>
<li> Skills in software testing is a bonus. </li>
</ul>
---

## Eligibility

We are seeking individuals who meet the following criteria:
- Experience in technical writing
- Decent knowledge in the tech domain
- Skills in software testing (bonus)

---

## The Process

1. **Register Yourself:** Fill out [this form](https://forms.gle/ZP72SpWdNyjg4gbu8) and register to the writers program. We'll be earger to have you along.
2. **Onboarding Starts:** Get onboard with us, learn about Keploy's ecosystem, connect with the team & mentors.
3. **Research your Idea** You'll start by choosing and researching about your write-up. Get access to mentorship & resources by the team.
4. **Craft your Work:** Start crafting your ideas into words. This part includes you working on the approved ideas and topics.
5. **Revision & Submissions:** This includes copy editing, hero image design, and revision of your article. Yes, we got to help you revise it before submitting.
6. **Publication** Once the content meets all the guidlines, you're all set to publish your content with Keploy, earn and redeem your benefits.
1. **Register Yourself:** Fill out [this form](https://forms.gle/ZP72SpWdNyjg4gbu8) to register for the writers program. We're eager to have you join us!
2. **Onboarding:** Get onboarded, learn about Keploy's ecosystem, and connect with the team & mentors.
3. **Research Your Idea:** Choose and research your article topic. Access mentorship & resources from the team.
4. **Craft Your Work:** Start writing your article based on the approved idea and topic.
5. **Revision & Submission:** Revise your article with our help, including copy editing and hero image design, before submitting.
6. **Publication:** Once your content meets all guidelines, it will be published and you can earn your benefits.

---

## Technical Writing Guidelines

### Conditions

1. As stated in the publishing policy, we only accept 100% fresh write-ups(of any kind). We strictly do not encourage republishing any existing work or even a portion of it. Keploy doesn't accept agency work, promotional material, or sponsored posts of any kind.
2. Minimum <u>700</u> word count.
3. Chosen keywords must have a search volume greater than <u> 400 </u>. [know about search volume [here](https://www.google.com/search?q=what+is+search+volume+in+seo&sca_esv=a07f0383584960a3&ei=XuoxZ7ScHtfhseMPlY-1mAk&ved=0ahUKEwi0w8GzltSJAxXXcGwGHZVHDZMQ4dUDCA8&uact=5&oq=what+is+search+volume+in+seo&gs_lp=Egxnd3Mtd2l6LXNlcnAiHHdoYXQgaXMgc2VhcmNoIHZvbHVtZSBpbiBzZW8yCxAAGIAEGJECGIoFMgYQABgWGB4yCxAAGIAEGIYDGIoFMgsQABiABBiGAxiKBTIIEAAYgAQYogQyCBAAGIAEGKIESO40UKsHWKMxcAZ4AJABAJgBhQGgAcEZqgEFMTcuMTW4AQPIAQD4AQGYAiWgAusZwgIKEAAYsAMY1gQYR8ICERAuGIAEGJECGNEDGMcBGIoFwgILEAAYgAQYsQMYgwHCAggQABiABBixA8ICIBAuGIAEGJECGNEDGMcBGIoFGJcFGNwEGN4EGOAE2AEBwgIQEAAYgAQYsQMYQxiDARiKBcICBRAAGIAEwgIKEAAYgAQYQxiKBcICCxAAGIAEGLEDGIoFwgIIEC4YgAQYsQPCAg4QABiABBixAxiDARiKBcICDhAAGIAEGJECGLEDGIoFwgIFECEYoAHCAggQABgWGB4YD5gDAIgGAZAGCLoGBggBEAEYFJIHBTE2LjIxoAePvgE&sclient=gws-wiz-serp)]
4. Adhere strictly to the plagiarism policy.
1. Only 100% original write-ups are accepted. Republishing existing work or agency/promotional/sponsored posts is not allowed.
2. Minimum **700** word count.
3. Chosen keywords must have a search volume greater than **400**. ([Learn more about search volume](https://www.google.com/search?q=what+is+search+volume+in+seo))
4. Strictly adhere to the plagiarism policy.
5. Understand and comply with the Terms and Conditions of the Keploy Community Writing Program.

### Rewards
---

Our compensation amounts are measures in <u>USD</u> ($)
## Rewards

- $10 for 350 views on article.
- $20 for 500 views on article.
- $50 for 1000 views on article.
- $100 for 2000 views on article.
Our compensation amounts are measured in **USD ($)**:
- $10 for 350 views on an article
- $20 for 500 views on an article
- $50 for 1000 views on an article
- $100 for 2000 views on an article

Valid for 1 published submission per candidate, after 30-days of publishing date. The Submitted work must fulfill all the given criteria.
(Compensations might be subject to any updates. Changes will be informed to all onboarded candidates on priority and updates will be made suitably in the guide.)
*Valid for one published submission per candidate, after 30 days of the publishing date. The submitted work must fulfill all the given criteria. Compensation may be updated; changes will be communicated to all onboarded candidates and reflected in the guide.*

---

## Terms and Conditions

Keploy Community Writing Program Standard Terms & Conditions:

- Submissions do not establish an employment relationship; you are an independent contractor.
- You grant Keploy a perpetual, non-revocable license for your submitted content.
- All content is licensed under Creative Commons Attribution-Noncommercial-ShareAlike 4.0 (CC BY-NC-SA 4.0).
- You must comply with all applicable laws, including copyright laws, and Keploy's Terms of Service.
- Keploy is not liable for any damages related to this agreement.
- You warrant that your content does not infringe on third-party intellectual property rights.

---

## Plagiarism Policy

Keploy blog requires original content. Any copied or reproduced work will result in immediate cessation of collaboration, potentially without notice. This includes:
- Rewording existing posts as your own
- Copying and pasting external documentation without proper attribution
- Modifying someone else's code without significant original contributions
- Using copyrighted images without permission

Rewording existing posts as your own.
Copying and pasting external documentation without proper attribution.
Modifying someone else's code without significant original contributions.
Using copyrighted images without permission.
If unsure about plagiarism concerns, consult with the Keploy content team before submission.

---

## Screenshots
Screenshots can enhance your article by visually representing instructions. Ensure all content in the images is your original work and does not include copyrighted material. For clarity:

- Increase font size for readability.
- Crop to focus on relevant elements.
- Remove unnecessary details.
Screenshots can enhance your article by visually representing instructions. Ensure all content in the images is your original work and does not include copyrighted material. For clarity:
- Increase font size for readability
- Crop to focus on relevant elements
- Remove unnecessary details

---

## FAQs

### How do I get involved?

Review our process for submitting ideas. When you submit a new idea, following details must be answered:
Review our process for submitting ideas. When you submit a new idea, please provide:
- Article title and content summary
- Outline of the article, with descriptions of what each section will cover
- Information about prerequisite knowledge the reader will need
- Link to a previous writing sample that demonstrates your capabilities

- Article title and content summary.
- Outline of the article, and descriptions of what each section will cover.
- Information about prerequisite knowledge the reader will need to have.
- Link to previous writing sample that demonstrates your capabilities.
Our editorial staff will reach out to let you know if we want to publish your content and will make recommendations for revisions. Once we’ve agreed that we’re happy with the idea, we’ll send you a contract that agrees on the scope of the article and the compensation. From there, it’s up to you to write the first draft and submit it for review!
Our editorial staff will reach out to let you know if we want to publish your content and may recommend revisions. Once we agree on the idea, we'll send you a contract outlining the scope and compensation. Then, you write the first draft and submit it for review!

### How do you evaluate content ideas?

Our team reviews every submission, and we look for technical content that comprehensively covers software development topics with clear explanations. Explain as much detail as possible and leave no concepts out.
Our team reviews every submission, looking for technical content that comprehensively covers software development topics with clear explanations. Explain as much detail as possible and leave no concepts out.

---

## Contact & Support

For questions, support, or to suggest improvements, reach out via [Slack](https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg) or email us at [email protected].