Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (41 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

54 lines (41 loc) · 2.17 KB

Contributing to ColorHex 🎨

First off, thank you for considering contributing to ColorHex! It's people like you that make ColorHex such a great tool.

How Can I Contribute?

Reporting Bugs

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

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

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

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful to most ColorHex users.

Pull Requests

The process described here has several goals:

  • Maintain ColorHex's quality
  • Fix bugs and deliver features faster
  • Limit accessibility issues
  • Help newcomers and experienced developers contribute with ease
  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

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

  • Use ES6 features where possible.
  • Prefer const over let and let over var.
  • Use 2 spaces for indentation.

CSS Styleguide

  • Use Vanilla CSS.
  • Follow the Neo-Brutalist design system established in style.css.
  • Use CSS variables defined in :root.

Questions?

Feel free to contact us at taqnikin@gmail.com or open an issue for discussion.