Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 2.5 KB
Raw

Contributing to IITH Dashboard

Thank you for considering contributing to the IITH Dashboard project!

How to Contribute

Outside of github, we use Feedbase for a mroe user friendly way to get feedback and fetch bug reports. Please feel to add comments, feedback, and bug reports here: Dashboard Feedbase

You can skip to Contributing Code, if its not related to Reporting Bugs or Suggesting Features.

Reporting Bugs

If you encounter any bugs or issues while using the IITH Dashboard, please report them so we can improve the project. Here’s how to report a bug:

  1. Search Existing Issues: Before creating a new issue, please check the existing issues to see if the problem has already been reported.

  2. Create a New Issue:

    • Go to the Issues tab and click on New Issue.
    • Select the Bug Report template.
    • Provide a clear and concise description of the issue, including steps to reproduce it, the expected behavior, and any relevant screenshots or logs.

  3. Label the Issue: Use appropriate labels such as bug, help wanted, or good first issue to categorize the problem.

Suggesting Features

We are always looking to improve the IITH Dashboard with new and exciting features. If you have an idea, follow these steps to suggest a feature:

  1. Search Existing Feature Requests: Check if someone has already proposed your idea in the Issues section.

  2. Create a New Feature Request:

    • Navigate to the Issues tab and click on New Issue.
    • Select the Feature Request template.
    • Provide a detailed description of the feature, including the problem it solves, potential use cases, and any relevant mockups or diagrams.

  3. Label the Feature Request: Use labels such as enhancement, feature, or discussion to identify the request.

Contributing Code

We welcome code contributions that improve the functionality, performance, or maintainability of the IITH Dashboard. To contribute code:

  1. Fork the Repository: Create a personal copy of the repository by clicking the Fork button.

  2. Clone the Repository: Clone the repository to your local machine using Git.

    git clone https://github.com/your-username/dashboard.git
cd dashboard