Skip to content

Commit c2385db

Browse files
authored
Update CONTRIBUTING.md
1 parent 39d14a9 commit c2385db

1 file changed

Lines changed: 21 additions & 32 deletions

File tree

CONTRIBUTING.md

Lines changed: 21 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,20 @@ Read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
1212

1313
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/))
1414

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-
17-
2.If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also.
18-
19-
3.Fork the repo and create a new branch from the `main` branch.
20-
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
22-
23-
6.Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
24-
25-
7.Rebase `main` with your branch and push your changes.
26-
27-
###🏡 Setup for local development
28-
29-
- 1. Git clone: `git clone git@github.com:testsigmahq/testsigma-tutorials.git`
30-
- 2. `cd testsigma-tutorials`
31-
- 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`
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`
3529

3630
Now you can access tutorials on your local server using http://localhost:8000/tutorials/
3731

@@ -42,22 +36,17 @@ The main branch (protected) contains the code that is tested and released. Pull
4236

4337
Once you are done with the code changes on your local machine, follow the below steps to commit.
4438

45-
### Commit & Create Pull Requests
46-
47-
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)
48-
49-
2.Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
50-
51-
3.Rebase `main` with your branch and push your changes.
52-
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.
54-
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)
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)
5645

5746
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.
5847

5948

60-
### Commit messages
49+
#### **Commit messages**
6150

6251
- The first line should be a summary of the changes, not exceeding 50
6352
characters, followed by an optional body that has more details about the

0 commit comments

Comments
 (0)