Skip to content

Latest commit

 

History

History
128 lines (85 loc) · 3.32 KB

contribution.md

File metadata and controls

128 lines (85 loc) · 3.32 KB
Raw

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
  2. Getting Started
  3. How to Contribute
  4. Pull Request Process
  5. Style Guides
  6. Reporting Issues
  7. Community and Support

Code of Conduct

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

Getting Started

Fork the Repository

  1. Navigate to the repository.
  2. Click on the "Fork" button in the top right corner.

Clone Your Fork

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

Set Upstream Remote

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

Create a New Branch

Before making any changes, create a new branch:

git checkout -b your-branch-name

How to Contribute

Adding New Features or Fixing Bugs

  1. Ensure your branch is up-to-date with the main branch:
  git checkout main
  git pull upstream main
  git checkout your-branch-name
  git rebase main
  1. Make your changes, adding tests if applicable.
  2. Commit your changes with a meaningful commit message:
  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:
  git add .
  git commit -m "Updated documentation for [specific feature/section]"

Pull Request Process

  1. Push your changes to your forked repository:
  git push origin your-branch-name
  1. Go to the original repository and open a Pull Request (PR).
  2. In the PR description, provide a detailed explanation of your changes and reference any related issues.
  3. Ensure your branch has no merge conflicts with the main branch.
  4. 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.