Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bhaskar1001101 authored Oct 4, 2023
1 parent e43894f commit 76b10e8
Showing 1 changed file with 79 additions and 0 deletions.
79 changes: 79 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# GDSC IIIT Kalyani Hacktoberfest Website Contribution Guidelines

Thank you for considering contributing to the GDSC IIIT Kalyani's Hacktoberfest website! We welcome contributions from everyone. By participating in this project, you agree to abide by the following guidelines to ensure a productive and collaborative environment.

## Table of Contents

- [Getting Started](#getting-started)
- [How to Contribute](#how-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Working on Issues](#working-on-issues)
- [Creating Pull Requests](#creating-pull-requests)
- [Coding Guidelines](#coding-guidelines)
- [Commit Message Guidelines](#commit-message-guidelines)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## Getting Started

Before contributing, please make sure you have:

1. Forked the repository to your own GitHub account.
2. Cloned the forked repository to your local machine.
3. Installed any necessary dependencies.

## How to Contribute

### Reporting Bugs

If you find any bugs or issues on the website, please follow these steps:

1. Check the existing issues to see if the bug has already been reported.
2. If not, open a new issue and provide detailed information about the bug, including steps to reproduce it and any error messages you encounter.

### Suggesting Enhancements

We welcome suggestions for improvements or new features. To suggest an enhancement:

1. Check the existing issues to see if your idea has already been suggested.
2. If not, open a new issue and describe your proposed enhancement in detail, including why it would be valuable.

### Working on Issues

If you find an open issue that you'd like to work on, please:

1. Comment on the issue to express your interest and let others know you're working on it.
2. Fork the repository if you haven't already.
3. Create a new branch for your work (`git checkout -b feature/your-feature-name`).
4. Implement the changes or fixes.
5. Ensure that your code adheres to the coding guidelines (see [Coding Guidelines](#coding-guidelines)).
6. Create a pull request (PR) when you're ready for review.

### Creating Pull Requests

When creating a pull request, please:

1. Give it a clear and descriptive title.
2. Provide a summary of the changes and explain why they are necessary.
3. Reference any related issues by including the issue number in the PR description.
4. Be responsive to feedback and make necessary changes if requested.
5. Ensure that all tests pass and the code is well-documented.
6. Follow the [Commit Message Guidelines](#commit-message-guidelines).

## Coding Guidelines

To maintain consistency and readability in the codebase, please adhere to the following guidelines:

1. Use clear and descriptive variable and function names.
2. Follow the indentation and formatting conventions used in the existing code.
3. Write comments to explain complex logic or non-obvious parts of the code.
4. Keep the code DRY (Don't Repeat Yourself).

### Commit Message Guidelines

1. Write a clear commit message which will be a breif about the changes

### Code of Conduct

# GDSC IIIT Kalyani Hacktoberfest Code of Conduct

0 comments on commit 76b10e8

Please sign in to comment.