contributing

Guide commit message creation and pull request submission to project standards.

18|1|Updated Jun 2, 2023
One-click install
npx skills add https://github.com/DaRacci/nix-config --skill contributing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: contributing
Source: https://github.com/DaRacci/nix-config/tree/main/.opencode/skills/contributing
Command: npx skills add https://github.com/DaRacci/nix-config --skill contributing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all contributions to the project adhere to established coding standards, commit message formats, and pull request guidelines, leading to a more organized and maintainable codebase.

Core Features & Use Cases

  • Code Formatting: Automatically formats code to maintain consistency.
  • Commit Message Validation: Enforces a structured commit message format for clarity and automation.
  • Pull Request Guidance: Provides a clear template and checklist for submitting pull requests.
  • Use Case: Before submitting a new feature, you can use this Skill to verify your commit messages and ensure your code is formatted correctly, preventing common review blockers.

Quick Start

Follow the guidelines in this skill to prepare your changes for submission.

Frequently Asked Questions about contributing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a conventional commit message for a pull request?

A conventional commit message uses a structured format to ensure clarity in collaborative code management. This Skill validates your commit messages against project standards, ensuring they meet the structured format required for automated processing and clear project history.

What is the best way to format code before submitting a pull request?

The best way to format code before a pull request is to run automated formatting checks. This Skill provides pre-submission validation to automatically format code, maintaining consistency and preventing common code review blockers.

How do I create a pull request description that meets project standards?

To create a compliant pull request description, use a structured PR template. This Skill provides a clear template and checklist for submitting pull requests, guiding you to include necessary information according to project standards.

Why does pre-submission validation matter for developer workflow?

Pre-submission validation matters because it ensures code formatting and commit messages adhere to established standards before review. This prevents common review blockers, leading to a more organized and maintainable codebase.

Do I need any specific git tools to use conventional commit validation?

No specific external git tools are required. This Skill operates without dependencies to guide you in creating conventional commit messages, performing validation and formatting checks directly according to project standards.