CONTRIBUTING.md

Contributing to rmstale

Hello, contributor! We're thrilled to have you on board and grateful for your contributions to the project. Your efforts help make rmstale even better. 🎉

This document outlines the guidelines for contributing to the project. We strive to maintain a welcoming and efficient process for contributions. While we accept issues and pull requests that don't strictly follow these guidelines, adherence to them can significantly speed up the merging process.

Table of Contents

• Contributing to rmstale
  • Table of Contents
  • Code of Conduct
  • Before You Start
  • How to Contribute
    • Reporting Bugs
    • Suggesting Enhancements
    • Contributing Code

Code of Conduct

This project and everyone participating in it are governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour to project maintainers.

Before You Start

rmstale is a small, lightweight, cross-platform tool intended primarily for command-line usage. While contributions that add functionality specific to one platform are welcome, they should not impair the tool's operation on other platforms. Similarly, while we welcome additions that introduce new user interfaces, these should not detract from the command-line interface.

How to Contribute

Reporting Bugs

Before submitting a bug report, please:

• Check existing issues to avoid duplicates.
• Explore Discussions for similar topics.

When reporting bugs, create a GitHub issue providing:

• A clear title and description.
• Expected vs. actual behavior.
• Steps to reproduce the issue.
• Any relevant environment details (OS, tool versions).

Suggesting Enhancements

For feature requests and enhancements, please use GitHub issues to describe:

• The desired feature/enhancement.
• Its potential benefits.
• Any preliminary ideas on how it might be implemented.

Contributing Code

1. Fork the Repository: Start by forking the repository to your GitHub account.
2. Clone Locally: Clone your forked repository to your local machine to start working on changes.
3. Branch: Create a new branch for your feature or bug fix. Branch names should be descriptive (e.g., feat/feature-x or fix/issue-y).
4. Develop: Make your changes, adhering to the project's coding standards and guidelines. Write or update tests as necessary.
5. Commit: Use clear and descriptive commit messages. Break up large changes into smaller commits that are easier to review.
6. Test: Run the project's test suite to ensure your changes don't break existing functionality.
7. Pull Request: Push your changes to your fork and submit a pull request to the main repository. Provide a clear description of the changes and any related issue numbers.

We welcome contributions of all sizes and thank you for taking the time to contribute to rmstale!

Thank you for contributing to rmstale. Your efforts are greatly appreciated by the community!