Skip to content

Commit 62ac889

Browse files
vikram-chaitanyaPratheepVKRrukmangada
authored
Initial Release (#1)
Initial Release Co-authored-by: Pratheep Velicherla <pratheep.velicherla@gmail.com> Co-authored-by: KR <krnaidu@testsigma.com> Co-authored-by: rukmangada <89924986+rukmangada@users.noreply.github.com>
1 parent 0617803 commit 62ac889

67 files changed

Lines changed: 47892 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
node_modules/
2+
.cache/
3+
public
4+
.idea/*
5+
*.iml
6+
.env
7+
.DS_Store

CODE_OF_CONDUCT.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders of this open-source project pledge
7+
to make participation in our community and contribution to our project an
8+
inclusive experience for everyone, regardless of age, body size, visible or
9+
invisible disability, ethnicity, gender identity, and expression, sexual identity
10+
and orientation, level of experience, education, socio-economic status,
11+
nationality, personal appearance, race, caste, color, or religion.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people.
22+
* Being respectful of differing opinions, viewpoints, and experiences.
23+
* Giving and gracefully accepting constructive feedback.
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience.
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community.
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
community@testsigma.com
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing to Tutorials
2+
3+
Testsigma docs are built using [Gatsby](https://www.gatsbyjs.com/) and deployed to [https://testsigma.com/tutorials/.](https://testsigma.com/tutorials/)
4+
5+
If you feel insecure about how to start contributing, feel free to ask us on our [Discord Server](https://discord.com/invite/5caWS7R6QX), in the #contributors channel.
6+
7+
## **Code of conduct**
8+
9+
Read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
10+
11+
## **Getting Started**
12+
13+
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/))
14+
15+
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/testsigmahq/testsigma-tutorials/issues/new/choose)
16+
2. If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also.
17+
3. Fork the repo and create a new branch from the `main` branch.
18+
4. Please name the branch as issue-[issue-number]-[issue-name(optional)]. For example, if you are fixing Issue #205 name your branch as issue-205 or issue-205-how to-automate-date-widget
19+
6. Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
20+
7. Rebase `main` with your branch and push your changes.
21+
22+
#### 🏡 Setup for local development
23+
1. Git clone: `git clone git@github.com:testsigmahq/testsigma-tutorials.git`
24+
2. `cd testsigma-tutorials`
25+
3. Create a branch `git checkout -b issue-[issue-number]-[issue-name(optional)]`
26+
4. `cd testsigma-tutorials`
27+
5. `npm install`
28+
6. `npm start`
29+
30+
Now you can access tutorials on your local server using http://localhost:8000/tutorials/
31+
32+
33+
## **Committing code**
34+
35+
The main branch (protected) contains the code that is tested and released. Pull requests should be made against the main branch. `main` contains all of the new changes that ready to go out in the next update.
36+
37+
Once you are done with the code changes on your local machine, follow the below steps to commit.
38+
39+
#### **Commit & Create Pull Requests**
40+
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/testsigmahq/testsigma-tutorials/issues/new/choose)
41+
2. Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
42+
3. Rebase `main` with your branch and push your changes.
43+
4. Once you are confident in your code changes, create a pull request in your fork to the main branch in the testsigmahq/testsigma-tutorials base repository.
44+
5. Link the issue of the base repository in your Pull request description. [Guide](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)
45+
46+
For all contributions, a CLA (Contributor License Agreement) needs to be signed [here](https://cla-assistant.io/testsigmahq/testsigma-tutorials) before (or after) the pull request has been submitted. A bot will prompt contributors to sign the CLA via a pull request comment, if necessary.
47+
48+
49+
#### **Commit messages**
50+
51+
- The first line should be a summary of the changes, not exceeding 50
52+
characters, followed by an optional body that has more details about the
53+
changes. Refer to [this link](https://github.com/erlang/otp/wiki/writing-good-commit-messages)
54+
for more information on writing good commit messages.
55+
56+
- Don't add a period/dot (.) at the end of the summary line.
57+
58+
## **Notes**
59+
- Tutorials are currently deployed manually. Changes will not reflect immediately after a PR gets merged.
60+
- The search is powered by [Algolia](https://www.algolia.com/) and is updated every day. Your local changes will not be reflected in search results

0 commit comments

Comments
 (0)