Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 2.5 KB
Raw

Contributing to Image Resizer

First off, thank you for considering contributing to Image Resizer! It's people like you that make this project a great tool. This document provides guidelines and steps for contributing.

Hacktoberfest

Image Resizer is participating in Hacktoberfest! If you're here for Hacktoberfest, welcome! Please ensure your contributions are meaningful and not just minor edits. We value quality over quantity.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to the project owner/s.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with your suggestion.
  • Clearly describe the enhancement and the motivation for it.
  • Ensure it's not already in the issues list.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Hacktoberfest-specific Guidelines

  • Ensure your PRs are in line with the spirit of Hacktoberfest. No spammy PRs!
  • Quality over quantity. It's better to have one meaningful PR than five PRs with minor text edits.
  • If you're fixing a bug or adding a feature, discuss it in an issue first.

Style Guides

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 Style Guide

Adhere to the StandardJS style.

HTML/CSS Style Guide

  • Use soft tabs (2 spaces) for indentation.
  • Prefer dashes over camelCasing in class names.
  • Do not use ID selectors.
  • When using multiple selectors in a rule declaration, give each selector its own line.

Additional Notes

Issue and Pull Request Labels

This repo uses labels to manage work on the project.