Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (47 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

64 lines (47 loc) · 2.81 KB
Raw

Contributing to Kevinbot P2 Board

Thank you for your interest in contributing to Kevinbot P2 Board! ❤️
Your contributions, whether in code, documentation, or ideas, help the project grow. Please take a moment to review this guide to make the process easier for everyone.

Ways to Support the Project

Even if you don't have time to contribute directly, you can support us by:

  • Starring the repository
  • Sharing it on social media
  • Mentioning it in your project's README

Table of Contents

I Have a Question

Before asking:

  1. Check the Documentation.
  2. Search the Issues and Discussions.

Still need help?
Open a new topic in Q&A, providing as much context as possible.

I Want to Contribute

Reporting Bugs

Before Submitting a Bug Report

  1. Make sure you're using the latest KiCAD version (if applicable).
  2. Verify the issue isn't due to configuration or environment issues.
  3. Search the bug tracker to see if the issue has already been reported.
  4. Gather the following details:
    • Software versions (e.g., KiCAD, P2 Compiler)
    • Reproduction steps or related input/output

Submitting a Bug Report

Sensitive issues (e.g., security bugs) should be reported via email at meowmeowahr@gmail.com.

For all other issues:

  • Open a GitHub issue.
  • Describe the expected and actual behavior, along with clear reproduction steps.
  • Include the details you gathered earlier.

Suggesting Enhancements

Before Submitting an Enhancement

  1. Make sure you're using the latest version.
  2. Check the documentation to ensure the feature isn't already covered.
  3. Search the issue tracker for similar suggestions.

Submitting an Enhancement Suggestion

  1. Discuss your idea in the Discussions section.
  2. Once your idea is clear, open a new issue with:
    • A descriptive title
    • A detailed explanation of the suggestion and expected outcome
    • Why the feature would benefit users

This guide was created using contributing-gen.