Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

83 lines (52 loc) · 2.25 KB

Contributing to Reslink-Dashboard

Thank you for your interest in contributing to Reslink-Dashboard! We welcome all types of contributions and appreciate your help in making this project better.

How to Contribute

To contribute to Reslink-Dashboard, please follow these steps:

  1. Fork the repository

    First, fork the repository by clicking the "Fork" button at the top right corner of the GitHub page. This creates a copy of the repository under your GitHub account.

  2. Clone the Forked Repository

    Clone your forked repository to your local machine using the following command in your Git Bash terminal:

    git clone [email protected]:your-username/Reslink-Dashboard.git

  3. Project Setup

  • Open the Clone Repo folder
   cd repo_name
  • Navigate to dashboard folder.
   cd dashboard
  • Install Dependencies.
   npm i
  • Run The Project.
   npm run dev

  1. Make your changes

  2. Submit a pull request

    • Before making any PR please create an Issue
    • If you find any upgradation or bug in the website, you can create your own issue or work on the previous issues.
    • When creating PR make sure you tag the required issue using # issuenumber Happy Coding!!

Your First Code Contribution

If you are making your first code contribution, please follow these guidelines:

  • Make sure to read the README.md file to understand the project structure and requirements
  • Use clear and concise commit messages
  • Follow the styleguides for code and documentation

Improving the Documentation

If you want to improve the documentation, please follow these guidelines:

  • Use clear and concise language
  • Make sure to include all necessary information
  • Follow the styleguides for documentation

Styleguides

Please follow these styleguides when contributing to Reslink-Dashboard:

  • Use clear and concise language
  • Follow the appropriate language-specific style guide, such as the Google Style Guides, to maintain consistency in your code.
  • Use SemVer for versioning

Attribution

This CONTRIBUTING.md file is based on the contributing.md example and template found at https://contributing.md/example/.