Skip to content

docs: add CONTRIBUTING guide, PR template, and issue templates#243

Open
JemimahEkong wants to merge 4 commits intoCalebux:mainfrom
JemimahEkong:docs/create-CONTRIBUTING.md-and-templates
Open

docs: add CONTRIBUTING guide, PR template, and issue templates#243
JemimahEkong wants to merge 4 commits intoCalebux:mainfrom
JemimahEkong:docs/create-CONTRIBUTING.md-and-templates

Conversation

@JemimahEkong
Copy link
Copy Markdown

Description

This PR adds essential contributor documentation to improve onboarding and contribution quality across the repository.


What’s Included

  • Added CONTRIBUTING.md with:

    • Development setup (backend, client, database)
    • Environment variable guidance
    • Branch naming and commit conventions
    • PR guidelines and code review standards
  • Added PR template:

    • Standardizes pull request structure and review expectations
  • Added issue templates:

    • Bug report template
    • Feature request template

Why This Matters

New contributors previously lacked clear guidance on how to:

  • Set up the project locally
  • Structure contributions
  • Follow consistent coding and PR standards

These additions reduce friction, improve code quality, and make collaboration more efficient.


Test Plan

  • Verified all commands in CONTRIBUTING.md align with project scripts
  • Confirmed templates render correctly in GitHub UI
  • Ensured documentation is clear and actionable for new contributors

Related Issue

Closes #190


Checklist

  • Documentation is clear and complete
  • Commands reflect actual project setup
  • No unrelated changes included

Created contribution guidelines and branch protection policies for SYNCRO.
Add a pull request template for contributors.
Added a bug report template for issue tracking.
Add a template for feature requests with sections for description, problem, proposed solution, alternatives, and additional context.
@drips-wave
Copy link
Copy Markdown

drips-wave bot commented Mar 27, 2026

@JemimahEkong Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md with development setup, PR guidelines, and code standards

1 participant