Skip to content

Instantly share code, notes, and snippets.

@kevinah95

kevinah95/CONTRIBUTING-example.md

Created February 19, 2023 07:55
Show Gist options
  • Save kevinah95/342f44840fa230b9fd885e12e7442548 to your computer and use it in GitHub Desktop.
Save kevinah95/342f44840fa230b9fd885e12e7442548 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
CONTRIBUTING-example.md

How to Contribute

The contribution guideline is derived from the SlimPHP, Istanbul Code Coverage and Ruby contribution guideline

Table of Contents

Pull Requests

{repo-name} uses the GitHub flow as main versioning workflow

  1. Fork the {repo-name} repository
  2. Create a new branch for each feature, fix or improvement
  3. Send a pull request from each feature branch to the main branch

It is very important to separate new features or improvements into separate feature branches, and to send a pull request for each branch.

This allow us to review and pull in new features or improvements individually.

Improving The Documentation

{repo-name} follows Keep a changelog principles. Please update CHANGELOG.md file to track changes.

Styleguides

Commit Messages

All pull requests and commits SHOULD adhere to the Conventional Commits specification

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment