Skip to content

Conversation

@Convly
Copy link
Member

@Convly Convly commented Feb 21, 2025

What does it do?

Add a CONTRIBUTING.md documentation file to the repository root.

Details the following points:

  • 📋 Prerequisites
  • 🛠 Setting Up the Project
      1. Clone the Repository
      1. Install Dependencies
  • 🏗️ Compiling the Changes
    • Build
    • Watch
    • Output
  • 🧪 Testing the Changes
    • Unit Tests
      • Running Unit Tests
      • Test Coverage
      • Configuration
      • Writing Tests
      • Mocks
    • Demos
      • Setting Up the Demos
      • Run the Demos
  • 🔎 Verifying Your Contribution
  • 📝 Commit Messages
  • 🎉 You're Ready to Contribute!
  • 🔐 Pull Request Reviews
    • The Review
    • Merging a PR
  • 📚 Releases

Why is it needed?

Better document the contribution process, remove friction for both first time contributors and maintainers

@Convly Convly added the pr: doc Documentating code / readmes label Feb 21, 2025
@Convly Convly added the source: repo Source is the repository label Feb 21, 2025
@Convly Convly changed the title docs: add contributing documentation docs: add contribution documentation Feb 21, 2025
Convly and others added 3 commits February 24, 2025 09:41
Co-authored-by: Ben Irvin <ben.irvin@strapi.io>
Co-authored-by: Ben Irvin <ben.irvin@strapi.io>
Co-authored-by: Ben Irvin <ben.irvin@strapi.io>
@Convly Convly force-pushed the docs/contributing-init branch from 2697a6c to 33366e2 Compare February 24, 2025 08:42
@Convly Convly merged commit 91f6e89 into main Feb 24, 2025
7 checks passed
@Convly Convly deleted the docs/contributing-init branch February 24, 2025 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr: doc Documentating code / readmes source: repo Source is the repository

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants