Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
186 lines (135 loc) · 6.47 KB

CONTRIBUTING.md

File metadata and controls

186 lines (135 loc) · 6.47 KB

Contributing to RunCat365

Thank you for your interest in contributing to RunCat365 🐈
RunCat365 is a Windows system monitoring application represented as a running cat animation.

All kinds of contributions are welcome: bug reports, feature requests, and code contributions.

This document describes the rules, steps, and expectations for contributing to this project.

Before Getting Started

  • Only contributions in English are accepted. Any contribution in another language may be closed.
  • This project is Windows-only. Issues or requests related to Linux, macOS, or other platforms will not be accepted.
  • Always use the provided Issue and Pull Request templates. Submissions that do not follow the templates may be closed.
  • Be respectful, constructive, and professional in all interactions.

Table of Contents

Issues

Bug Reports

To report a bug:

  1. Make sure there is no existing issue reporting the same bug.
    If one exists, add any additional relevant information as a comment instead of creating a new issue.
  2. Click New issue and select the Bug Report template.
  3. Follow all checklist steps and confirm that the bug still occurs.
  4. Provide clear and complete information. More details help maintainers resolve the issue faster.
  5. Submit the issue and stay attentive, as maintainers may request additional information.

Feature Requests

To suggest a new feature:

  1. Check if a similar feature request already exists.
    If so, please contribute to the existing discussion instead of opening a new one.
  2. Ensure your suggestion benefits a broad range of users and is not only a personal preference.
  3. Click New issue and select the Feature Request template.
  4. Fill out the template as clearly and completely as possible.
  5. Submit the issue and remain available for follow-up questions.

Other Issues

Important

This option is only for issues that do not fit into the categories above. Issues that do not use the appropriate template will be closed without notice.

  1. Click New issue and select Blank issue.
  2. Describe your request clearly and in detail.
  3. Submit the issue and stay attentive to maintainer feedback.

Pull Requests

Before Opening a Pull Request

  • .NET 9.0 is required.
  • All code must be written in English.
    Use the localization system for user-facing text in other languages.
  • Use the Allman indentation style.
  • Use var when the type is obvious from the assignment.
  • Follow the existing formatting and conventions used in the codebase.
  • Keep each pull request focused on a single change or context. For multiple unrelated changes, create separate pull requests.
  • Keep code clean, readable, and easy to understand.
  • This repository is licensed under Apache-2.0.

Cloning and Working on the Repository

  1. Fork the main branch.

  2. Make sure Git is installed.

  3. Clone your fork locally:

    git clone https://github.com/your-username/RunCat365.git
cd RunCat365

  4. Create a new branch:

    git switch -c branch-name

    Use a short, descriptive branch name.

  5. Make your changes using your preferred IDE (Visual Studio is recommended).

  6. Keep functions within their respective classes.

  7. Verify that the project builds and runs without errors.

  8. Ensure no unnecessary or accidental changes were made.

  9. Stage your changes:

    git add .

  10. Commit your changes:

    git commit -m "Clear and descriptive commit message"

  11. Push the branch:

    git push origin branch-name

Submitting a Pull Request

  1. Click New pull request.
  2. Select the branch you worked on.
  3. Choose the type of contribution.
  4. Fill in all requested information clearly and completely.
  5. Ensure all checklist items are satisfied.
  6. Submit the pull request.

Code Style Guidelines

  • Follow existing project conventions.
  • Use the Allman indentation style.
  • Use meaningful and descriptive names.
  • Avoid unnecessary complexity.
  • Prefer readable and self-explanatory code over clever solutions.

Review Process

  • Pull requests are reviewed as time permits.
  • Not all contributions are guaranteed to be accepted.
  • Maintainers may request changes before merging.
  • Inactive or non-responsive pull requests may be closed.

Community Reviews

  • Reviews and comments from non-maintainer community members are welcome and appreciated.
  • However, only feedback from maintainers is considered official, and only maintainers decide whether a pull request is merged.
  • Community reviewers may not be fully familiar with this project's contribution guidelines, so their suggestions may not always align with project policy.
  • Contributors are free to consider community feedback, but should use their own judgment and wait for maintainer review before treating any change as required.

Responding to Review Comments

  • Do not click Resolve conversation unless you are the reviewer. Even after pushing a fix in response to a review comment, only the reviewer can decide whether the issue is actually resolved. Pushing a follow-up commit and resolving the conversation yourself bypasses that judgment.
  • Address each review comment individually rather than bundling them together, unless there is a clear reason to combine them. The larger a single response or diff becomes, the harder it is for the reviewer to evaluate whether each point has been handled correctly. Reply to each comment with the corresponding change so that the discussion stays focused and easy to follow.

Thank You

Thank you again for contributing to RunCat365. Your time and effort help make this project better for everyone 😸