You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-29Lines changed: 18 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Testsigma docs are built using [Gatsby](https://www.gatsbyjs.com/) and deployed to [https://testsigma.com/tutorials/.](https://testsigma.com/tutorials/)
4
4
5
-
If you feel insecure about how to start contributing, feel free to ask us on our [Discord channel](https://discord.com/invite/5caWS7R6QX), in the #contributors channel.
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
6
7
7
## **Code of conduct**
8
8
@@ -12,42 +12,33 @@ Read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
12
12
13
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
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)
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
16
17
17
2.If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also.
18
18
19
-
3.Fork the repo and create a new branch from the main branch.
19
+
3.Fork the repo and create a new branch from the `main` branch.
20
20
21
-
4.Please name the branch as issue-[issue-number]-[issue-name(optional)] or new-addon-[feature-number]–[feature-name(optional)]. For example, if you are fixing Issue #205 name your branch as issue-205 or issue-205-selectbox-handling-changes
22
-
23
-
5.Please add tests for your changes.
21
+
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
24
22
25
23
6.Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
26
24
27
-
7.Rebase master with your branch and push your changes.
25
+
7.Rebase `main` with your branch and push your changes.
-3. Create a branch `git checkout -b issue-[issue-number]-[issue-name(optional)]`
32
+
-4.`cd testsigma-tutorials`
33
+
-5.`npm install`
34
+
-6.`npm start`
43
35
44
-
Now you can access docs on your local server using http://localhost:8000/tutorials
36
+
Now you can access tutorials on your local server using http://localhost:8000/tutorials/
45
37
46
38
47
39
## **Committing code**
48
40
49
-
The main branch (protected) contains the code that is tested and released.
50
-
Pull requests should be made against the main branch. main contains all of the new features and fixes that are under testing and ready to go out in the next release.
41
+
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.
51
42
52
43
Once you are done with the code changes on your local machine, follow the below steps to commit.
53
44
@@ -57,9 +48,9 @@ Once you are done with the code changes on your local machine, follow the below
57
48
58
49
2.Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
59
50
60
-
3.Rebase master with your branch and push your changes.
51
+
3.Rebase `main` with your branch and push your changes.
61
52
62
-
4.Once you are confident in your code changes, create a pull request in your fork to the main branch in the testsigmahq/testsigma-docs base repository.
53
+
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.
63
54
64
55
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)
65
56
@@ -75,8 +66,6 @@ For all contributions, a CLA (Contributor License Agreement) needs to be signed
75
66
76
67
- Don't add a period/dot (.) at the end of the summary line.
77
68
78
-
[[info | NOTE:]]
79
-
|
80
-
* Docs are currently deployed manually. Changes will
81
-
not reflect immediately after a PR gets merged.
82
-
* 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
69
+
## **Notes**
70
+
- Tutorials are currently deployed manually. Changes will not reflect immediately after a PR gets merged.
71
+
- 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