commiter-cli/CONTRIBUTING.md

A CLI tool to standardize and translate Git commit messages

# Contributing to Commiter CLI

Thank you for considering contributing! We ❤️ community involvement.

## Table of Contents
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Development Setup](#development-setup)
- [Branching & Workflow](#branching--workflow)
- [Commit Message Guidelines](#commit-message-guidelines)
- [Pull Request Process](#pull-request-process)
- [Thank You](#thank-you)

---

## Reporting Bugs

1. Search existing [issues](https://github.com/odutradev/commiter-cli/issues) to see if the problem has already been reported.  
2. If not, open a new issue and include:
   - A clear and descriptive title.  
   - Steps to reproduce the issue.  
   - Expected vs. actual behavior.  
   - Environment details (OS, Node.js version, commiter-cli version).

---

## Suggesting Enhancements

1. Check if a similar feature request already exists.  
2. Open an issue with:
   - A summary of the proposed feature.  
   - Motivation and use cases.  
   - Any relevant examples or mockups.

---

## Development Setup

To run locally, simply execute:
```
<type>: <short summary>
```
- **type**: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`  
- **short summary**: imperative, max ~50 characters  

**Example:**
```
feat: add translation error fallback prompt

If translation fails, ask user to keep the original message.  
Closes #42.
```

---

## Pull Request Process

1. Fork the repository and clone your fork.  
2. Create a feature branch.  
3. Make your changes, ensuring linting and formatting rules pass.  
4. Commit using Conventional Commits.  
5. Push to your fork.  
6. Open a pull request against `odutradev/commiter-cli:main` and include:
   - Description of changes.  
   - Link to related issues.  
   - Screenshots or examples if applicable.  
7. Address any review feedback.  
8. Once approved and CI passes, your PR will be merged.

---

## Thank You

Thank you for helping improve **Commiter CLI**! Your contributions make this project better for everyone. 🎉