Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

62 lines (47 loc) · 2.29 KB

Contributing to IIITV 5G and Edge Computing Activity 👾📡

Thank you for considering contributing to IIITV 5G and Edge Computing Activity!
We welcome contributions of all kinds, including bug reports, feature suggestions, code improvements, documentation, and more.

This document provides guidelines to ensure a smooth and productive collaboration for everyone involved.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Coding Guidelines
  4. Pull Request Checklist
  5. Code of Conduct
  6. Need Help?

Getting Started

  1. Understand the Purpose: Start by familiarising yourself with the goals of the repository. Read the README.md file carefully to understand the project’s objectives.
  2. Set Up the Environment: Follow the setup instructions in the repository's documentation.
  3. Check Open Issues: Look at the Issues section in the repositories to find out on what needs help.

How to Contribute

Reporting Issues

If you find a bug, inconsistency, or have an idea to improve the project, please create an issue:

  1. Go to the Issues tab of the repository.
  2. Click on New Issue.
  3. Use a clear and descriptive title.
  4. Provide as much detail as possible:
    • Steps to reproduce the problem.
    • Expected and actual behavior.
    • Screenshots or logs if applicable.
  5. Add appropriate labels (e.g., bug, enhancement, etc.).

Suggesting Features

We love new ideas! To suggest a feature:

  1. Check if the feature has already been requested in the Issues section.
  2. If not, open a New Issue and use the enhancement label.
  3. Provide:
    • A detailed description of the feature.
    • How it improves the project or solves a specific problem.
    • Any examples or references for implementation.

Submitting Code Changes

To contribute code:

  1. Fork the Repository: Click the "Fork" button at the top-right of the repository page.
  2. Clone Your Fork: 
    git clone https://github.com/<your-username>/<repository-name>.git
cd <repository-name>