Initial commit

Author: saurabh-prakash

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders of this open-source project pledge 
+to make participation in our community and contribution to our project an 
+inclusive experience for everyone, regardless of age, body size, visible or 
+invisible disability, ethnicity, gender identity, and expression, sexual identity 
+and orientation, level of experience, education, socio-economic status, 
+nationality, personal appearance, race, caste, color, or religion.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people.
+* Being respectful of differing opinions, viewpoints, and experiences.
+* Giving and gracefully accepting constructive feedback.
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience.
+* Focusing on what is best not just for us as individuals, but for the overall
+  community.
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected]
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

@@ -0,0 +1,122 @@
+# Contributing to Test-at-scale
+
+Thank you for your interest in Test-at-scale and for taking the time to contribute to this project. If you feel insecure about how to start contributing, feel free to ask us on our [Discord Server](https://discord.gg/Wyf8srhf6K) in the #contribute channel.
+
+## **Code of conduct**
+
+Read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
+
+
+## **How can I contribute?**
+
+There are many ways in which you can contribute to Test-at-scale.
+
+#### 👥 Join the community
+  Join our [Discord server](https://discord.gg/Wyf8srhf6K), help others use Test-at-scale for their test automation requirements.
+
+#### 🗣️ Give a talk about Test-at-scale
+  You can talk about Test-at-scale in online/offline meetups. Drop a line to [[email protected]](mailto:[email protected]) ahead of time and we'll send you some swag. 👕
+
+#### 🧩 Build an Add-on 
+  Enhance Test-at-scale’s capabilities by building add-ons to solve unique problems. 
+
+#### 🐞 Report a bug
+  Report all issues through GitHub Issues and provide as much information as you can.
+
+#### 🛠 Create a feature request
+  We welcome all feature requests, whether for new features or enhancements to existing features. File your feature request through GitHub Issues.
+
+#### 📝 Improve the documentation
+  Suggest improvements to our documentation using the [Documentation Improvement](https://github.com/LambdaTest/test-at-scale/issues/new) template. Test-at-scale docs are published on [here](https://www.lambdatest.com/support/docs/getting-started-with-tas/)
+
+
+#### 📚 Contribute to Tutorials 
+  You can help by suggesting improvements to our tutorials using the [Tutorials Improvement](https://github.com/LambdaTest/test-at-scale/issues/new) template or create a new tutorial. 
+
+
+#### ⚙️ Write code to fix a Bug / new Feature Request
+  We welcome contributions that help make Test-at-scale bug-free & improve the test automation experience for our users. You can also find issues tagged [Good First Issues](https://github.com/LambdaTest/test-at-scale/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22"). Check out the below sections to begin.
+
+ 
+
+## **Writing Code**
+All submissions, including submissions by project members, require review. Before raising a pull request, ensure you have raised a corresponding issue and discussed a possible solution with a maintainer. This gives your pull request the highest chance of getting merged quickly. Join our [Discord Server](https://discord.gg/Wyf8srhf6K) if you need any help.
+
+ 
+### First-time contributors
+We appreciate first-time contributors and we are happy to assist you in getting started. In case of questions, just [reach out to us!](https://discord.gg/Wyf8srhf6K)
+You find all issues suitable for first-time contributors [here.](https://github.com/LambdaTest/test-at-scale/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+
+
+### Repo overview
+
+[LambdtaTest/test-at-scale](https://github.com/LambdaTest/test-at-scale/) consists of 2 components:
+
+- **Synapse:** is the agent responsible for fetching jobs from Test at Scale servers to execute them on the self hosted environment (your laptop or your server farm). Synapse coordinates with nucleus (test runner) and TAS cloud to execute tests and push out test details such as test name, test suite, execution logs, execution metrics.
+- **Test Runners:** component is the driving agent of the container executed to run the actions received by synapse. All actions will be executed on Linux containers and itself manages the lifecycle of the container. It provides functionalities such as logging, metric collections, etc. It primarily conducts two primary stages viz. test discovery and test execution. Both of these stage are accomplished by using plugins for language and framework to make sure nucleus is not tightly coupled with specific languages.
+ 
+<details>
+<summary>Read More</summary>
+We've engineered the platform such that you can setup the test-runners anywhere, from your local workstation to any cloud (AWS, Azure, GCP etc), as per your convenience. 
+<p align="center">
+<img loading="lazy" src={require('https://staging.lambdatest.com/support/assets/images/synapse-tas-interaction-a70a50f02b2e6e99491777ce636538f4.png').default} alt="Synapse Architecture" width="1340" height="617" className="doc_img"/>
+</p>
+
+When you configure TAS to run in a self-hosted environment, all the test execution jobs are executed inside your  environment. Your code stays within your setup environment. To provide you with test-insights on the TAS portal we store information only related to tests like name of testFile, testCase, testSuite and execution logs. At no point, we collect business logic of your code.
+
+
+Here is a sample flow to understand how it works:
+- After Configure TAS self-hosted mode and integrating your repositories into TAS platform.
+- Whenever you make a commit, raise a PR or merge a PR, the TAS platform receives a webhook event from your git provider.
+- This webhook event is simply sent to your self-hosted environment to initate jobs for test execution.
+- The Test-at-scale binary running on your self hosted enviroment spawns containers to execute those jobs.
+- Basic test metadata is sent to the TAS server to provide you with test insights and other relevant statistics over the TAS dashboard.
+- Your code or business logic never leaves your setup environment.
+- As your workload increases you can add more servers running Test-at-scale binary, which will distribute the load amongst them automatically.
+- Routing: TAS platform will send the test execution jobs  to the connected self hosted environments  which are online and have enough resources to run the job.
+- If the resources are insufficient or fully occupied, the jobs will remain queued on for 2.5 hour and keep checking for resource availability every 30 seconds.
+- If TAS platform is unable to find any connected self-hosted binary which can execute the job, it will be marked as failed.
+ 
+</details>
+
+### Set up your branch to write code
+
+We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull requests. [Learn more.](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/) 
+
+ 1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, [create an issue.](https://github.com/LambdaTest/test-at-scale/issues)
+ 2. If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also.
+ 3. Fork the repo and create a new branch from the `dev` branch.
+ 4. Please name the branch as <span style="color:grey">issue-[issue-number]-[issue-name(optional)]</span> or <span style="color:grey">feature-[feature-number]–[feature-name(optional)]</span>. For example, if you are fixing Issue #205 name your branch as <span style="color:grey">issue-205 or  issue-205-selectbox-handling-changes</span>
+ 5. Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
+ 6. Rebase `dev` with your branch and push your changes.
+ 7. Raise a pull request against the staging branch of the main repository.
+
+
+## **Committing code**
+
+The repository contains two important (protected) branches.
+
+ * main contains the code that is tested and released. 
+ * dev contains recent developments under testing. This branch is set as the default branch, and all pull requests should be made against this branch.
+
+Pull requests should be made against the <span style="color:grey">dev</span> branch. <span style="color:grey">staging</span> contains all of the new features and fixes that are under testing and ready to go out in the next release.
+
+
+#### **Commit & Create Pull Requests** 
+
+ 1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, [create an issue](https://github.com/LambdaTest/test-at-scale/issues).
+ 2. Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
+ 3. Rebase `dev` with your branch and push your changes.
+ 4. Once you are confident in your code changes, create a pull request in your fork to the `dev` branch in the LambdaTest/test-at-scale base repository.
+ 5. Link the issue of the base repository in your Pull request description. [Guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
+ 6. Fill out the [Pull Request Template](./pull_request_template.md) completely within the body of the PR. If you feel some areas are not relevant add `N/A` but don’t delete those sections.
+
+
+####  **Commit messages**
+
+- The first line should be a summary of the changes, not exceeding 50
+  characters, followed by an optional body that has more details about the
+  changes. Refer to [this link](https://github.com/erlang/otp/wiki/writing-good-commit-messages)
+  for more information on writing good commit messages.
+
+- Don't add a period/dot (.) at the end of the summary line.

.github/ISSUE_TEMPLATE/1-bug-report.yaml

@@ -0,0 +1,51 @@
+name: 🐞 Bug report
+description: Create a bug report to help us improve Test-at-scale
+title: "[Bug]: "
+labels: [bug, needs-triaging]
+assignees:
+- nevilm-lt
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thanks for taking the time to fill out this bug report! Please fill the form in English
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: What is the current behavior?
+    description: Add a brief description of what you are experiencing.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: What is the expected behavior?
+    description: A brief description of what you expect.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Add steps to reproduce this behavior, include console / network logs & screenshots
+    placeholder: |
+      1. 
+      2. 
+      3.
+      4.
+  validations:
+    required: true
+- type: dropdown
+  id: version
+  attributes:
+    label: Version
+    options:
+      - Test-at-scale Cloud
+      - Test-at-scale Community Edition
+      - Test-at-scale Enterprise Edition
+  validations:
+    required: true

.github/ISSUE_TEMPLATE/2-feature-request.yaml

@@ -0,0 +1,31 @@
+name: 🛠️ Feature request
+description: Suggest an idea to improve Test-at-scale
+title: "[Feature]: "
+labels: [enhancement]
+assignees:
+- anmol-LT
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue related to this feature request already exists.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: What would you like to add?
+    description: A clear description of the feature or enhancement wanted in Test-at-scale.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Why should this be worked on?
+    description: A concise description of the problems or use cases for this feature request. 
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Other details
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/3-documentation-improvement.yaml

@@ -0,0 +1,36 @@
+name: 📖 Docs & Tutorials Improvement
+description: Suggest improvements to our docs and tutorials 
+title: "[Docs & Tutorials]: "
+labels: [docs-tutorials]
+assignees:
+- nevilm-lt
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thanks for taking the time to fill out this docs/tutorials improvement request!
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue realated to this already exists.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: input
+  attributes:
+    label: Doc/tutorial link 
+    description: Add a link to the page which needs improvement (optional)
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Explain the problem
+    description: Is the documentation/tutorial missing? Or is it not clear? What is not clear?
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Your inputs to improve
+    description: Your inputs to improve/add new documentation or tutorial.  
+  validations:
+    required: true