Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 2.35 KB

Contributing to IIIT Dharwad Website

Thank you for your interest in contributing to the IIIT Dharwad website! We welcome contributions from the community to help improve and enhance the website.

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Install the necessary dependencies by running npm install or yarn install.
  4. Create a new branch for your feature or bug fix: git checkout -b my-feature-branch.
  5. Make your changes and commit them with descriptive commit messages.
  6. Push your changes to your forked repository.
  7. Open a pull request (PR) against the main repository's dev branch.

Development Setup

To set up the development environment, follow these steps:

  1. Ensure you have Node.js (version 18.x or higher) installed on your machine.
  2. Clone the repository and navigate to the project directory.
  3. Run npm install to install the required dependencies.
  4. Run npm run dev to start the development server.
  5. Open your browser and visit http://localhost:3000 to see the website.

Code Style and Linting

We follow a consistent code style and use linting tools to maintain code quality. Please ensure that your code adheres to the following guidelines:

  • Use meaningful variable and function names.
  • Follow the JavaScript/TypeScript coding conventions.
  • Run npm run lint to check for linting errors.

Commit Message Style Guide

All pull requests SHOULD adhere to the Conventional Commits specification

View the convention of commit messages locally here

Pull Request Process

When submitting a pull request, please ensure the following:

  1. Provide a clear and descriptive title for your pull request.
  2. Include a detailed description of the changes made and the problem it solves.
  3. Reference any relevant issues or pull requests in the description.
  4. Ensure that your code passes all linting checks.
  5. Be open to feedback and be willing to make changes based on the review comments.

Issue Reporting

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. When reporting an issue, provide as much detail as possible, including steps to reproduce the problem, expected behavior, and actual behavior.