Skip to content
This repository was archived by the owner on Mar 2, 2025. It is now read-only.

Latest commit

 

History

History
107 lines (82 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

107 lines (82 loc) · 3.52 KB

Contributing to UberCoders

Thank you for considering contributing to UberCoders! We're excited to have you help us grow and improve this project. Whether you're here to report a bug, suggest a feature, or submit a pull request, your contributions are highly appreciated.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Development Setup
  4. Pull Request Guidelines
  5. Getting Help

Code of Conduct

Please adhere to our Code of Conduct in all interactions. Respect, collaboration, and inclusivity are the foundation of this community.

How to Contribute

Reporting Bugs

If you find a bug, please help us by reporting it:

  1. Check existing issues to ensure the bug hasn’t been reported yet.
  2. Open a new issue and include:
    • A clear title and description of the problem.
    • Steps to reproduce the bug.
    • Expected vs. actual behavior.
    • Relevant screenshots or logs (if applicable).

Suggesting Features

We’re always looking for great ideas! To suggest a feature:

  1. Check existing issues to ensure your idea hasn’t been proposed already.
  2. Open a feature request issue and include:
    • A detailed explanation of your feature.
    • The problem it solves or the benefit it provides.
    • Any additional context or resources (e.g., references, mockups).

Code Contributions

We welcome contributions of code for bug fixes, new features, or improvements. Follow the steps below to get started.

Development Setup

Prerequisites

Before contributing, ensure you have:

Steps

  1. Fork the repository.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/ubercoder
  3. Navigate to the project directory: 
    cd ubercoder
  4. Create a new branch for your work: 
    git checkout -b feature/your-feature-name
  5. Make your changes and test them thoroughly.

Pull Request Guidelines

Submitting a Pull Request (PR)

  1. Ensure your changes are on a separate branch (not main or master).
  2. Push your branch to your fork: 
    git push origin feature/your-feature-name
  3. Open a PR on the original repository:
    • Go to Pull Requests.
    • Click New Pull Request and select your branch.
  4. Fill out the PR template with:
    • A clear description of the changes.
    • Reference to related issues (e.g., "Fixes #123").
    • Any additional notes or context.

Guidelines

  • Follow the coding style used in the project.
  • Write clear, concise commit messages.
  • Include tests for your changes, if applicable.
  • Ensure your changes do not break existing functionality.

Getting Help

If you need help at any stage:

We’re thrilled to have you contributing to UberCoders! Together, let’s make this project great.