added docs #2
added docs #2
Conversation
…Docs + New Project Docs + Developer Workflow Directory + automated gha checks docs + Development Setup Directory + docker installation file + keploy installation file
|
|
cc @nehagup |
|
cc @nehagup |
| @@ -0,0 +1,38 @@ | |||
| _DeveloperWorkflow: | |||
There was a problem hiding this comment.
The formatting needs correction. Check the preview.
|
|
||
| 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`_ |
There was a problem hiding this comment.
Any reason why "_" after Keploy?
| - 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 |
There was a problem hiding this comment.
In the Preview images are not rendering.
There was a problem hiding this comment.
Changes with my images link but once you merge this PR i can change the link with keploy repo
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). |
There was a problem hiding this comment.
There are other options as well!
- There's a Discord channel.
- 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.
|
|
||
| 6. Get credit for your work | ||
|
|
||
| - [Claim credit]() if you are not listed yet. |
There was a problem hiding this comment.
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]() |
There was a problem hiding this comment.
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). |
There was a problem hiding this comment.
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]() |
There was a problem hiding this comment.
Because many folders and many things are not done
|
@Ayush7614 are you still working on this? |
|
Yes |
|
cc @nehagup |
|
@Ayush7614 We need to add the folders and files before merging this with empty links. |
This PR Contains