Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (38 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 2.45 KB
Raw

Contributing to Chrome Search Tab

Thank you for your interest in contributing to Chrome Search Tab! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to [project maintainer's email].

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

Before creating enhancement suggestions, please check the issue list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Follow the JavaScript and CSS styleguides
  • Include adequate tests
  • Document new code based on the Documentation Styleguide
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

All JavaScript code is linted with ESLint and formatted with Prettier.

CSS Styleguide

All CSS/LESS code is linted and follows the project's styling conventions.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are bugs
  • enhancement - Issues that are feature requests
  • documentation - Issues or pull requests related to documentation
  • good first issue - Good for newcomers

Thank You!

Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute.