contribution-guidelines

Enforce PR workflows, code reviews, and commit conventions for the CIA project.

235|56|Updated Aug 1, 2015

Search Tags:#code-review #contribute #open-source #git-workflow #pull-request #conventional-commits #CONTRIBUTING.md

Ready to run

npx skills add https://github.com/Hack23/cia --skill contribution-guidelines

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: contribution-guidelines
Source: https://github.com/Hack23/cia/tree/main/.github/skills/contribution-guidelines
Command: npx skills add https://github.com/Hack23/cia --skill contribution-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill standardizes how contributors interact with the CIA project, providing a clear PR workflow, code-review expectations, and commit conventions to ensure consistent quality and collaboration.

Core Features & Use Cases

PR workflow guidance: forking, branching, review, and merging.
Code-review checklist: maintainability, tests, security, and documentation.
Commit conventions: use Conventional Commits and standardized messages.
Reference pointers: links to CONTRIBUTING.md, CODE_OF_CONDUCT.md, and PR templates to align teams.

Quick Start

Clone the repository and follow the guidelines: fork the project, create a feature branch, implement changes with tests, push to GitHub, and open a PR following the documented process.

Frequently Asked Questions about contribution-guidelines

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

FAQPage Schema

What is the pull request workflow for contributing to an open-source project?▼

A code review checklist for pull requests should cover maintainability, tests, security, and documentation. Following this checklist ensures consistent quality and collaboration when evaluating external contributions.

How do I format conventional commits for a pull request?▼

Conventional commits require standardized commit messages following a defined format. Adhering to these commit conventions streamlines the PR workflow and ensures consistent quality for bug fixes, features, and documentation updates.

Do I need to read CONTRIBUTING.md before submitting a pull request?▼

Yes, you need to read CONTRIBUTING.md and CODE_OF_CONDUCT.md before submitting a pull request. These references provide the documented process, align teams, and define the expectations for external contributions.

What's the best way to submit bug fixes and feature work via a pull request?▼

The best way to submit bug fixes and feature work is to fork the project, create a feature branch, implement changes with tests, and open a PR. Following the documented PR workflow and conventional commits ensures your contribution is merged.