Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

62 lines (37 loc) · 3.08 KB
Raw

Contributing to UR Cache Cleaner

Welcome to UR Cache Cleaner! We appreciate your interest in contributing to our project. Whether you want to report a bug, request a feature, or submit code changes, this guide will help you get started.

Ways to Contribute

  • Reporting Bugs: If you encounter any bugs or unexpected behavior, please report them by opening an issue on our GitHub Issues page. Provide detailed steps to reproduce and any relevant information to help us understand and address the issue.

  • Requesting Features: Have an idea for a new feature or improvement? We'd love to hear it! Open an issue on our GitHub repository and describe the feature you'd like to see. We'll review your suggestion and discuss its feasibility and implementation.

  • Submitting Pull Requests: Want to contribute code changes? Fork our repository, make your changes, and submit a pull request. Please ensure your code follows our coding standards and includes appropriate tests. We'll review your changes and merge them into the main branch if they align with our project goals.

Getting Started

To contribute to UR Cache Cleaner, follow these steps:

  1. Fork the Repository: Click the "Fork" button on the top right corner of our GitHub repository to create your copy of the project.

  2. Clone Your Fork: Clone your forked repository to your local machine using the following command:

    git clone https://github.com/vinugawade/ur-cache-cleaner.git

  3. Create a Branch: Create a new branch for your changes with a descriptive name:

    git checkout -b feature/my-new-feature

  4. Make Changes: Make your desired changes to the codebase. Ensure your changes adhere to our coding standards and guidelines.

  5. Commit Changes: Commit your changes with clear and concise commit messages:

    git commit -am 'Add new feature: my new feature'

  6. Push Changes: Push your changes to your forked repository:

    git push origin feature/my-new-feature

  7. Submit a Pull Request: Go to the Pull Requests tab of our repository and click "New Pull Request." Compare changes and submit your pull request. Be sure to provide a detailed description of your changes.

Code Guidelines

  • Follow the coding style and conventions used throughout the project.
  • Write clear, concise, and maintainable code.
  • Include comments where necessary to explain complex logic or functionality.
  • (Optional) Write unit tests for new features and ensure all tests pass before submitting a pull request.

Code of Conduct

Please review and adhere to our Code of Conduct to ensure a positive and inclusive community environment.

Contact

If you have any questions or need further assistance, feel free to contact us at vinulike11@gmail.com.

Thank you for contributing to UR Cache Cleaner! Your contributions help improve the project for everyone.