Skip to content

[MINOR] contributing guide #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hpdang merged 1 commit into from
Aug 20, 2025
Merged

[MINOR] contributing guide #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 116 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# Contributing to Scrum Helper

First off, thank you for considering contributing to Scrum Helper! It's people like you that make this such a great tool. We welcome any and all contributions.

This document provides guidelines for contributing to the project. Please feel free to propose changes to this document in a pull request.

## How Can I Contribute?

- **Reporting Bugs:** If you find a bug, please open an issue on our [GitHub Issues page](https://github.com/fossasia/scrum-helper/issues). Make sure to use the "Bug Report" template and provide as much detail as possible.
- **Suggesting Enhancements:** If you have an idea for a new feature or an improvement to an existing one, you can open an issue using the "Feature or Enhancement Request" template.
- **Pull Requests:** If you're ready to contribute code, we'd be happy to review your pull request.

## Setting Up Your Development Environment

1. **Fork & Clone the Repository**

```sh
git clone https://github.com/YOUR_USERNAME/scrum-helper.git
cd scrum-helper
```

2. **Install Dependencies**

```sh
npm install
```

3. **Load the Extension in Your Browser**

- Go to `chrome://extensions` in your Chrome browser.
- Enable "Developer Mode" (toggle in the top-right).
- Click "Load unpacked" and select the `src` folder inside the cloned repository.

4. **Get a GitHub Personal Access Token (Recommended)**

To use Scrum Helper with authenticated requests (for higher rate limits and private repositories), you need a GitHub personal access token.

- **Go to GitHub Developer Settings:** Visit [https://github.com/settings/tokens](https://github.com/settings/tokens).
- **Choose Token Type:** Select "Personal access tokens (classic)".
- **Generate a New Token:** Give it a descriptive name (e.g., "Scrum Helper Dev").
- **Create and Copy the Token:** Click "Generate token" and copy the token.
- **Paste the Token in Scrum Helper:** Open the extension popup, go to settings, and paste your token into the "GitHub Token" field.

## Submitting a Pull Request

1. **Create a Branch:** Create a new branch for your feature or bug fix.
2. **Make Your Changes:** Write your code and make sure to follow the project's style.
3. **Format and Lint Your Code:** Before committing, run the following commands to ensure your code is clean and consistent.

```sh
# Auto-format your code
npm run format

# Check for any linting or formatting issues
npm run check

# Automatically fix any fixable linting issues
npm run fix
```

4. **Commit and Push:** Commit your changes with a clear message and push them to your fork.
5. **Open a Pull Request:** Go to the original repository and open a pull request. Please use the provided pull request template.

### Writing Meaningful Pull Requests

The release notes are automatically generated from merged pull requests. To ensure the release notes are clear and helpful, please:

1. **Write a descriptive title.** The PR title is the primary entry in the release notes. It should concisely summarize the change.
2. **Provide a clear description.** The body of your PR should explain the "what" and "why" of your changes.

### Pull Request Labeling & Semantic Versioning

The project uses an automated release process that relies on pull request labels and titles to determine the semantic version. Please use one of the methods below.

**Method 1: Using Labels (Preferred)**

Apply **one** of the following labels to your pull request:

- `release:major`: For breaking changes.
- `release:minor`: For new features or significant enhancements.
- `release:patch`: For backward-compatible bug fixes or maintenance.
- `release:none`: To exclude the change from the release notes.

**Method 2: Using PR Titles (Fallback)**

If no label is applied, the system will inspect your PR title for keywords like `major`, `feat`, `fix`, etc.

If you are unsure, a maintainer will apply the correct label before merging.

## Adding a New Language

You can add a new language to Scrum Helper for your own use or contribute it to the project.

1. **Create a Locale Folder**
- Go to `src/_locales`.
- Create a new folder named with the [ISO language code](https://developer.chrome.com/docs/extensions/reference/i18n/#localeTable) (e.g., `it` for Italian, `fr` for French).

2. **Add a `messages.json` File**
- Copy the `messages.json` from `src/_locales/en/messages.json` or any other language as a template.
- Translate only the `"message"` values into your language.
**Do not translate the extension name ("Scrum Helper") or the footer ("Made with ❤️ by ...").**

3. **Test the Extension**
- Reload the extension in your browser.
- Change your browser or system language to your new locale (see your browser’s language settings).
- The extension will use your translation automatically if your language is set.

> **You do not need to make a pull request to use your language locally.**

### Contributing Your Translation

If you want to share your translation with others:
- Make a pull request with your new locale folder and `messages.json` file.
- We recommend double-checking your translations for accuracy and clarity.

For more details, see the [Chrome i18n documentation](https://developer.chrome.com/docs/extensions/reference/i18n/)
89 changes: 10 additions & 79 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,15 @@
- Edit it in the window.
- Copy the rich HTML using the `COPY` button.

## Contributing

We welcome contributions from the community! Whether it's reporting a bug, suggesting a new feature, or writing code, your help is appreciated.

Please read our **[Contributing Guide](CONTRIBUTING.md)** to learn how you can get involved.

## License

This project is licensed under the LGPL-2.1 License - see the [LICENSE](LICENSE) file for details.

## Screenshots

Expand Down Expand Up @@ -104,8 +113,6 @@ $ npm install
<!-- * For Firefox: Load it as a temporary add-on through `about:debugging` as described above. -->




2. **Build the Extension**
* For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
<!-- * For Firefox: Reload the temporary add-on by going to `about:debugging` → "This Firefox" → Click "Reload" next to your extension. -->
Expand Down Expand Up @@ -147,36 +154,6 @@ $ npm install



## Adding a New Language

You can add a new language to Scrum Helper for your own use, or contribute it to the project.

### Using a New Language Locally

1. **Create a Locale Folder**
- Go to `src/_locales`.
- Create a new folder named with the [ISO language code](https://developer.chrome.com/docs/extensions/reference/i18n/#localeTable) (e.g., `it` for Italian, `fr` for French).

2. **Add a `messages.json` File**
- Copy the `messages.json` from `src/_locales/en/messages.json` or any other language as a template.
- Translate only the `"message"` values into your language.
**Do not translate the extension name ("Scrum Helper") or the footer ("Made with ❤️ by ...").**

3. **Test the Extension**
- Reload the extension in your browser.
- Change your browser or system language to your new locale (see your browser’s language settings).
- The extension will use your translation automatically if your language is set.

> **You do not need to make a pull request to use your language locally.**

### Contributing Your Translation

If you want to share your translation with others:
- Make a pull request with your new locale folder and `messages.json` file.
- We recommend double-checking your translations for accuracy and clarity.

For more details, see the [Chrome i18n documentation](https://developer.chrome.com/docs/extensions/reference/i18n/).


## Release Process

Expand All @@ -202,51 +179,5 @@ This part is performed manually by maintainers when it's time to publish a new v
2. **Publishing**: The maintainer publishes the release from the GitHub UI.
3. **Chrome Web Store Deployment**: Publishing the release triggers the "Publish to Chrome Web Store" workflow, which automatically packages the extension and uploads it for review.

## About contributing

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

### Writing Meaningful Pull Requests

The release notes are automatically generated from the pull requests merged into `master`. To ensure the release notes are clear and helpful, please:

1. **Write a descriptive title.** The PR title is the primary entry in the release notes. It should concisely summarize the change.
2. **Provide a clear description.** The body of your PR should explain the "what" and "why" of your changes. This context is invaluable for reviewers and for anyone looking back at the project's history.

### Pull Request Labeling & Semantic Versioning
This project uses an automated release process that relies on pull request labels and titles to determine the semantic version for a new release. For your contribution to be included in the release notes, please use one of the methods below.

**Method 1: Using Labels (Preferred)**

The clearest way to signal the impact of your change is to apply **one** of the following labels to your pull request. This is the recommended approach.

- `release:major`: For breaking changes that are not backward-compatible.
- `release:minor`: For new features or significant enhancements.
- `release:patch`: For backward-compatible bug fixes, documentation updates, or maintenance.
- `release:none`: To exclude the change from the release notes entirely.

**Method 2: Using PR Titles**

As a fallback, if no `release:*` label is applied, the system will inspect your pull request title for the following keywords (case-insensitive) to determine the version bump:

- `major`: For breaking changes.
- `minor`: For new features.
- `patch`, `fix`, `chore`, `documentation` : For bug fixes and other small changes.

If you are unsure which label to use, please write a clear and descriptive title, and a maintainer will apply the correct label before merging.

- 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.
```sh
npm run format
```
- Check for issues: This command runs the formatter, linter, and import sorting on the requested files to enforce coding standards.
```sh
npm run check
```
- Fix linting errors: If the linter detects fixable issues, this command will automatically apply the necessary corrections.
```sh
npm run fix
```
- If you encounter any bugs, please report them at the [Issues page](https://github.com/fossasia/scrum_helper/issues).
### If you encounter any bugs, please report them at the [Issues page](https://github.com/fossasia/scrum_helper/issues).
Loading