git-groom/CONTRIBUTING.md

A CLI tool for cleaning up Git branches, tags, and remotes

# Contributing to Git Groom

Thank you for your interest in contributing to Git Groom! We welcome contributions of all kinds, including bug fixes, feature implementations, documentation improvements, and more.

## Getting Started

1. **Fork the Repository**: Click the "Fork" button at the top right of the [GitHub repository](https://github.com/Sirrine-Jonathan/git-groom) to create your own copy.
2. **Clone the Repository**: Clone your fork to your local machine.
   ```sh
   git clone https://github.com/your-username/git-groom.git
   cd git-groom
   ```
3. **Install Dependencies**: Ensure you have Node.js installed, then install dependencies.
   ```sh
   npm install
   ```
4. **Create a New Branch**: Make a new branch for your changes.
   ```sh
   git checkout -b feature-branch-name
   ```

## Making Changes

- Ensure your code follows best practices and is well-documented.
- Keep commits focused on a single issue or feature.
- Test your changes locally before submitting.

## Running Tests

If the project includes tests, run them with:

```sh
npm test
```

## Submitting Changes

1. **Commit your changes**: Follow conventional commit messages.
   ```sh
   git commit -m "feat: add new cleanup command"
   ```
2. **Push your branch**:
   ```sh
   git push origin feature-branch-name
   ```
3. **Open a Pull Request**: Navigate to the repository on GitHub and click "New Pull Request."

## Code of Conduct

Please be respectful, constructive, and collaborative. We follow the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/).

## Contact

If you have any questions, feel free to open an issue or reach out through the repository discussions.

Happy contributing!