Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 2.84 KB
Raw

Contributing to URL Slicer 🤝

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

📜 Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please read it before contributing.

🤔 How Can I Contribute?

🐛 Reporting Bugs

This section guides you through submitting a bug report for URL Slicer. 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 URL Slicer, including completely 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.
  • Provide specific examples to demonstrate the steps.

🛠️ 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
  • End all files with a newline

🚀 Getting Started

  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.

💻 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

CSS Style Guide

  • Use CSS custom properties for reusable values
  • Use meaningful class names
  • Write comments for complex selectors or rules

📝 Documentation

  • Use JSDoc comments for functions and classes
  • Keep README.md and other documentation up to date

❓ Questions?

Don't hesitate to contact the project maintainer if you have any questions:

Lyubomir Ternavskiy

Thank you for your interest in contributing to URL Slicer! We look forward to your contributions. 🎉

Made with ❤️ by the URL Slicer community