Skip to content

Navigation Menu

Sign in
Sign up

added docs - #2

Open
Ayush7614 wants to merge 13 commits into
keploy:main from
Ayush7614:main
Open

added docs #2
Ayush7614 wants to merge 13 commits into
keploy:main from
Ayush7614:main

Conversation

@Ayush7614

@Ayush7614 Ayush7614 commented May 8, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

This PR Contains

  • Added Contribute Docs
  • Credit Docs
  • Join Keploy Docs
  • Report Bugs Docs
  • New Project Docs
  • Developer Workflow Directory
  • Automated GHA checks docs
  • Development Setup Directory

nehagup reacted with thumbs up emoji

Ayush7614 commented May 8, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author
  • In many files link is not added because the docs are not written that`s why in next PR i am adding all docs and attached link
  • In Development Setup i am adding only files name in next PR docs was also added
  • One reason is also for link not added because of when this PR is merged then i added main repo links . Currently link is not generated because files is not merged yet.

Copy link
Copy Markdown
Contributor Author

cc @nehagup

Copy link
Copy Markdown
Contributor Author

cc @nehagup

@@ -0,0 +1,38 @@
_DeveloperWorkflow:

@nehagup nehagup May 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The formatting needs correction. Check the preview.

@Ayush7614 Ayush7614 Jun 14, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done


This section focuses on how these automated tests are set up and how they can
be configured on our GitHub repositories. Currently only the
following checks are available in our `keploy`_

@nehagup nehagup May 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Any reason why "_" after Keploy?

@Ayush7614 Ayush7614 Jun 14, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

chnages done

- In the case where tests fail, we can debug the problem from going
through the console output as displayed here.

.. figure:: ../images/check fails.png

@nehagup nehagup May 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

In the Preview images are not rendering.

@Ayush7614 Ayush7614 Jun 14, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Changes with my images link but once you merge this PR i can change the link with keploy repo

@Ayush7614 Ayush7614 Jun 14, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

image
Like this

Comment thread Contributing/How-to-Join-keploy.md Outdated

Keploy is increasingly looking for new developers to join us and help improve our processes. We can collaborate on developing new projects, improve existing pipelines or maintaining the existing projects. Please follow these steps to join keploy:

1. You can simply Join Keploy Slack Workspace from here and introduce yourself in genral channel [Slack Workspace](https://keploy.slack.com). No newline at end of file

@nehagup nehagup May 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

There are other options as well!

  1. There's a Discord channel.
  2. Github Discussions

If you're looking to contribute to anything specific then please feel free to reach out to any of the collaborators of that project directly on Slack/LinkedIn etc.

@Ayush7614 Ayush7614 Jun 14, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done


6. Get credit for your work

- [Claim credit]() if you are not listed yet. No newline at end of file

@nehagup nehagup May 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why is there an empty link?

@Ayush7614 Ayush7614 Jun 14, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Because many folders and many things are not done

- Review the bug-list, open issues, Project Board (if you want to code a new feature) or the [Plan](). To start a new Project follow these [guidelines](How-to-Start-a-New-Project.md).)
- Contact the Maintainers, if available in the README document, or the Repository Maintainer by submitting an [Issue]() with an @mention.

2. [Join the keploy organisation]()

@nehagup nehagup May 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why is there an empty link?

@Ayush7614 Ayush7614 Jun 14, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Because many folders and many things are not done


- Read the [Contributing guidelines](https://github.com/keploy/template/blob/main/CONTRIBUTING.md)
- Read the [Code of Conduct](../CODE_OF_CONDUCT.md)
- Review the [Coding Guidelines]() and the [Contribution Criteria](../CONTRIBUTING.md).

@nehagup nehagup May 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why is there an empty link?

@Ayush7614 Ayush7614 Jun 14, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Because many folders and many things are not done

- [Nest your team](https://help.github.com/en/articles/moving-a-team-in-your-organizations-hierarchy) into the right parent team, which means the repository team for new projects or the keploy team for new repositories
- Assign roles for Developers, Engineers, Editors, Maintainers (for code). Try to have at least 2 persons for each role to avoid overloading your team.

5. Follow the [regular project implementation cycle]() No newline at end of file

@nehagup nehagup May 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why is there an empty link?

@Ayush7614 Ayush7614 Jun 14, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Because many folders and many things are not done

nehagup commented May 12, 2022

Copy link
Copy Markdown
Member

@Ayush7614 are you still working on this?

Copy link
Copy Markdown
Contributor Author

Yes

Copy link
Copy Markdown
Contributor Author

cc @nehagup

nehagup commented Jun 14, 2022

Copy link
Copy Markdown
Member

@Ayush7614 We need to add the folders and files before merging this with empty links.

keploy Bot commented Apr 15, 2025 •
edited
Loading

Copy link
Copy Markdown

Nice Pr 😄. We currently support Unit Test Generation only for Go projects.
Stay tuned – support for more languages is coming soon! 🚀

1 similar comment

Copy link
Copy Markdown

Nice Pr 😄. We currently support Unit Test Generation only for Go projects.
Stay tuned – support for more languages is coming soon! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nehagup nehagup nehagup requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /