Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 2.17 KB
Raw

Contributing to URL-Shortener-App

Thank you for your interest in contributing to URL-Shortener-App! We welcome contributions from the community to make this project better. Before you get started, please take a moment to review the following guidelines.

Table of Contents

Code of Conduct

Please review our Code of Conduct before participating in our community.

How to Contribute

Reporting Bugs

If you encounter a bug, please open an issue on our GitHub repository. Make sure to include:

  • A clear and descriptive title.
  • A detailed description of the issue, including steps to reproduce it.
  • Information about your environment, such as operating system and browser (if applicable).

Adding Features

If you have an idea for a new feature or improvement, feel free to suggest it by opening an issue. We appreciate well-documented feature proposals that include:

  • A clear and descriptive title.
  • A detailed explanation of the feature.
  • Any relevant design or implementation details.

Documentation

Improvements to documentation are always welcome. If you find areas where the documentation can be enhanced, or if you want to contribute new documentation, please do so.

Pull Requests

When submitting pull requests, please follow these guidelines:

  1. Fork the repository and create a feature branch from the main branch.
  2. Ensure your code adheres to the code style guidelines.
  3. Write clear, concise commit messages.
  4. Test your changes thoroughly.
  5. Ensure that your pull request addresses an open issue or clearly states its purpose.
  6. Reference any related issues in your pull request description.

Getting Started

If you're new to contributing to open-source projects, you can start by checking out the list of open issues labeled as "good first issue." These issues are typically beginner-friendly.

Thank you for your contributions! 🚀