Skip to content

Commit

Permalink
fix : contribution documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Sumonta056 committed Jun 12, 2024
1 parent 6088785 commit 704bf58
Showing 1 changed file with 128 additions and 0 deletions.
128 changes: 128 additions & 0 deletions contribution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contribution Guide

Thank you for considering contributing to our GitHub repository! We appreciate your interest and effort in helping us improve and expand this project. To ensure a smooth and efficient contribution process, please follow the guidelines outlined below.

## Table of Contents

1. [Code of Conduct](#code-of-conduct)
2. [Getting Started](#getting-started)
3. [How to Contribute](#how-to-contribute)
4. [Pull Request Process](#pull-request-process)
5. [Style Guides](#style-guides)
6. [Reporting Issues](#reporting-issues)
7. [Community and Support](#community-and-support)

## Code of Conduct

By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it to understand the expectations we have for all contributors.

## Getting Started

### Fork the Repository

1. Navigate to the [repository](https://github.com/Sumonta056/GitHub-Tutorial).
2. Click on the "Fork" button in the top right corner.

#### Clone Your Fork

```bash
git clone https://github.com/Sumonta056/GitHub-Tutorial
```

```bash
cd GitHub-Tutorial
```

#### Set Upstream Remote

```bash
git remote add upstream https://github.com/Sumonta056/GitHub-Tutorial.git
```

```bash
git fetch upstream
```

#### Create a New Branch

Before making any changes, create a new branch:

```bash
git checkout -b your-branch-name
```

```bash

```

### How to Contribute

#### Adding New Features or Fixing Bugs

1. Ensure your branch is up-to-date with the main branch:

```bash
git checkout main
git pull upstream main
git checkout your-branch-name
git rebase main
```

2. Make your changes, adding tests if applicable.
3. Commit your changes with a meaningful commit message:

```bash
git add .
git commit -m "Brief description of your changes"
```

#### Improving Documentation

1. Follow the same steps as above for creating and updating branches.
2. Edit or add documentation in the appropriate files.
3. Commit your changes with a clear message:

```bash
git add .
git commit -m "Updated documentation for [specific feature/section]"
```

#### Pull Request Process

1. Push your changes to your forked repository:

```bash
git push origin your-branch-name
```

2. Go to the original repository and open a Pull Request (PR).
3. In the PR description, provide a detailed explanation of your changes and reference any related issues.
4. Ensure your branch has no merge conflicts with the main branch.
5. A project maintainer will review your PR. You may be asked to make additional changes.

### Style Guides

#### Code Style

- Follow the coding style guidelines established in the project.
- Use meaningful variable and function names.
- Maintain consistent indentation and formatting.

#### Commit Messages
- Use the present tense ("Add feature" not "Added feature").
- Keep messages concise and informative.
- Reference issues and pull requests liberally.

#### Documentation
- Write clear, concise, and helpful documentation.
- Use proper markdown syntax for formatting.

#### Reporting Issues
If you encounter a bug, have a question, or want to suggest an enhancement, please open an issue. When creating an issue, please include as much detail as possible.

#### Community and Support
Join our community to ask questions, share ideas, and get support:

- GitHub Discussions

Thank you for contributing! Your efforts help make this project better for everyone.

0 comments on commit 704bf58

Please sign in to comment.