@@ -5,16 +5,20 @@ This chrome extension helps you to write scrums in google groups for FOSSASIA re
5
5
![ SCRUMLOGO] ( docs/images/scrumhelper-png.png )
6
6
7
7
## How to install
8
- ```
9
- 1. Clone this repository.
10
- 2. Goto `chrome://extensions` on your chrome browser.
8
+
9
+ 1 . Clone this repository to your local machine .
10
+ 2 . Go to ` chrome://extensions ` on your chrome browser.
11
11
3 . Turn on developer mode if not already on.
12
12
4 . Load unpacked extension from ` src ` folder.
13
13
5 . Click on the Scrum Helper icon you see on your browser toolbar.
14
14
6 . Fill in the settings in the popup.
15
- 7. Open https://groups.google.com/forum/#!newtopic/<groupname>.
16
- 8. Refresh the page for new settings to reflect.
17
- ```
15
+ 7 . ** For Google Groups:**
16
+ - Open https://groups.google.com/forum/#!newtopic/ <groupname > and start a New Conversation.
17
+ 8 . Refresh the page to apply the new settings.
18
+ 9 . ** For Gmail, Yahoo, and Outlook:**
19
+ - Open the Compose window.
20
+ - Follow Step 8 to ensure the settings take effect.
21
+
18
22
## Setting up the code locally
19
23
20
24
```
@@ -30,4 +34,17 @@ $ npm install
30
34
## About contributing
31
35
- Follow the Issues and PRs templates as far as possible.
32
36
- If you want to make a PR, please mention in the corresponding issue that you are working on it.
33
- - Please run ` npm run test ` locally to check for syntax errors before making a PR.
37
+ - Before making a PR, ensure your code is properly formatted and linted:
38
+ - Format your code: This command automatically formats your code based on the project's style guidelines.
39
+ ``` sh
40
+ npm run format
41
+ ```
42
+ - Check for issues: This command runs the formatter, linter, and import sorting on the requested files to enforce coding standards.
43
+ ` ` ` sh
44
+ npm run check
45
+ ` ` `
46
+ - Fix linting errors: If the linter detects fixable issues, this command will automatically apply the necessary corrections.
47
+ ` ` ` sh
48
+ npm run fix
49
+ ` ` `
50
+ - If you encounter any bugs, please report them at the [Issues page](https://github.com/fossasia/scrum_helper/issues).
0 commit comments