SCRUM Helper is a Chrome extension designed to simplify writing scrums in Google Groups for FOSSASIA projects. By adding your GitHub username, date range, and other options, it automatically fetches your PRs, Issues, and reviewed PRs via the GitHub API and pre-fills the scrum. You can then edit the scrum to fit your needs.
- Fetches your GitHub PRs, Issues, and reviewed PRs
- Auto-generates scrum updates
- Supports Google Groups, Gmail, Yahoo, and Outlook compose windows
- Clone this repository to your local machine.
- Go to
chrome://extensionson your chrome browser. - Enable Developer Mode (toggle in the top-right) if not already.
- Click Load unpacked and select the
srcfolder inside the cloned repo - Click the Scrum Helper icon on your browser toolbar
- Fill in your settings in the popup (GitHub username, date range, etc.)
- Open Google Groups New Topic
- Start a New Conversation
- Refresh the page to apply the Scrum Helper settings
- Use the pre-filled scrum and edit as needed
- Open the Compose window.
- Ensure the Scrum Helper settings are applied (follow step 6 above)
- The extension will prefill scrum content for you to edit
$ git clone https://github.com/fossasia/scrum_helper/
$ cd scrum_helper
$ npm install
- Follow the Issues and PRs templates as far as possible.
- If you want to make a PR, please mention in the corresponding issue that you are working on it.
- Before making a PR, ensure your code is properly formatted and linted:
- Format your code: This command automatically formats your code based on the project's style guidelines.
npm run format
- Check for issues: This command runs the formatter, linter, and import sorting on the requested files to enforce coding standards.
npm run check
- Fix linting errors: If the linter detects fixable issues, this command will automatically apply the necessary corrections.
npm run fix
- Format your code: This command automatically formats your code based on the project's style guidelines.
- If you encounter any bugs, please report them at the Issues page.