Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (29 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 2.6 KB

Contributing to Hugo Blowfish Decap CMS Starter

Welcome to the Hugo Blowfish Decap CMS Starter project! We appreciate your interest in contributing. Before getting started, please take a moment to review the guidelines below to ensure a smooth contribution process.

Bugs & Other Issues

Found a Bug? 🐛

  • Check Existing Issues: Search GitHub Issues to ensure the bug hasn't already been reported.
  • Report a Bug: If not found, open a new issue with a clear title, description, code sample, screenshot, or test case demonstrating the issue.
  • Use Templates: Prefer using bug report templates when creating new issues.

Have a Patch?

  • Submit a PR: Fork the dev branch, make your changes, and submit a pull request with a clear description of the problem and solution.
  • Test Locally: Use npm run dev to test local changes using the example site.

New Features & Enhancements

Adding or Changing Features

  • Discuss First: Before implementation, open a new discussion to suggest your idea and ensure it aligns with the project's design and roadmap.
  • Check Discussions: Look for similar ideas in existing discussions before opening a new one.
  • PR Submission: If the community supports your idea, submit a PR with the feature.

Questions? 🙋‍♀️

  • General Questions: Ask using GitHub Discussions in the "Q&A" category.
  • Search First: Check existing Q&A discussions before posting a new question.

Coding Conventions

  • Indentation: Use 2 spaces for soft tabs.
  • Spacing: Add spaces between list items, around operators, and inside go templating tags.
  • Code Organization: Prioritize readability, extract components into partials, and add comments for clarity.
  • Asset Paths: Use relative paths without preceding slashes for assets and include a trailing slash for folders.
  • Commit Frequently: Make incremental changes and provide meaningful commit messages following Gitmoji guidelines.

Commit Message Guidelines

  • Use Gitmoji: Provide context using Gitmoji in commit messages.
  • Summary Line: Describe the change briefly in the first 72 characters using imperative language.
  • Detailed Explanation: Add detailed explanations below the summary.
  • Issue Reference: Reference GitHub issues fixed using their issue numbers.