Docs: Contributing.md #39

Author: Matars

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+---
+layout: default
+title: How to Contribute
+nav_order: 8
+---
+
+# Contributing to gitfetch
+
+We welcome contributions from everyone! This document provides guidelines and information for contributors.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [How to Contribute](#how-to-contribute)
+- [Development Setup](#development-setup)
+- [Pull Request Process](#pull-request-process)
+- [Types of Contributions](#types-of-contributions)
+
+## Getting Started
+
+1. **Create an issue** on Github
+2. **Fork the repository** on GitHub
+3. **Optional: Create a new Branch**
+4. **Make your changes**
+5. **Test your changes**
+6. **Submit a pull request**
+
+## How to Contribute
+
+### Issue-First Policy
+
+**Every change by a contributor must come AFTER creating an issue about it.**
+
+- **Create an issue first**: Before starting any work, create a GitHub issue describing what you want to implement or fix
+- **Link PRs to issues**: Every pull request must reference the related issue
+- **Maintainer exception**: Project maintainers can bypass this requirement for urgent fixes or minor changes
+
+## Development Setup
+
+### Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/your-username/gitfetch.git
+   cd gitfetch
+   ```
+
+2. Install:
+
+   ```bash
+   make dev
+   ```
+
+3. Verify installation:
+   ```bash
+   gitfetch --help
+   ```
+
+## Types of Contributions
+
+We welcome contributions in many forms:
+
+### Code Contributions
+
+- Bug fixes
+- New features
+- Performance improvements
+- Code refactoring
+
+### Documentation
+
+- README updates
+- Add screenshots of yourset in
+- User guides
+- Code comments
+
+### Testing
+
+- Unit tests
+- Integration tests
+- Test coverage improvements
+- CI/CD improvements
+
+### Design & UI
+
+- Terminal output improvements
+- Color scheme enhancements
+- ASCII art contributions
+- User experience improvements
+
+Thank you for contributing to gitfetch!

docs/CONTRIBUTING.md

@@ -0,0 +1,92 @@
+---
+layout: default
+title: How to Contribute
+nav_order: 8
+---
+
+# Contributing to gitfetch
+
+We welcome contributions from everyone! This document provides guidelines and information for contributors.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [How to Contribute](#how-to-contribute)
+- [Development Setup](#development-setup)
+- [Pull Request Process](#pull-request-process)
+- [Types of Contributions](#types-of-contributions)
+
+## Getting Started
+
+1. **Create an issue** on Github
+2. **Fork the repository** on GitHub
+3. **Optional: Create a new Branch**
+4. **Make your changes**
+5. **Test your changes**
+6. **Submit a pull request**
+
+## How to Contribute
+
+### Issue-First Policy
+
+**Every change by a contributor must come AFTER creating an issue about it.**
+
+- **Create an issue first**: Before starting any work, create a GitHub issue describing what you want to implement or fix
+- **Link PRs to issues**: Every pull request must reference the related issue
+- **Maintainer exception**: Project maintainers can bypass this requirement for urgent fixes or minor changes
+
+## Development Setup
+
+### Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/your-username/gitfetch.git
+   cd gitfetch
+   ```
+
+2. Install:
+
+   ```bash
+   make dev
+   ```
+
+3. Verify installation:
+   ```bash
+   gitfetch --help
+   ```
+
+## Types of Contributions
+
+We welcome contributions in many forms:
+
+### Code Contributions
+
+- Bug fixes
+- New features
+- Performance improvements
+- Code refactoring
+
+### Documentation
+
+- README updates
+- Add screenshots of yourset in
+- User guides
+- Code comments
+
+### Testing
+
+- Unit tests
+- Integration tests
+- Test coverage improvements
+- CI/CD improvements
+
+### Design & UI
+
+- Terminal output improvements
+- Color scheme enhancements
+- ASCII art contributions
+- User experience improvements
+
+Thank you for contributing to gitfetch!