Skip to content

Latest commit

 

History

History
164 lines (117 loc) · 3.79 KB

contributing.md

File metadata and controls

164 lines (117 loc) · 3.79 KB

Contributing to Civix

We appreciate your interest in contributing to Civix!
Civix aims to foster civic engagement and community collaboration, and we welcome contributors from all backgrounds.

👏 How you can contribute

  • Reporting bugs or issues
  • Suggesting new features or improvements
  • Submitting bug fixes or new code
  • Updating or adding to the documentation
  • Providing UI/UX suggestions or design tweaks

🛠 Setting up for development

  1. Fork the repository

  2. Clone the repository:

git clone https://github.com/HarshS16/Civix.git
cd Civix

git clone https://github.com/Harshs16/civix.git

  1. Set up the project.

Contributing Guidelines

Project Setup Instructions

Prerequisites Node.js and npm PostgreSQL

Before you start, make sure you have the following installed:

Installation

  1. Clone the repository:
  2. Install dependencies: 
        npm install
  3. Database Setup: Create a new database for Civix:
createdb civix

Edit your configuration (typically a .env) to connect to your Postgres database:

DB_NAME=civix
DB_HOST=localhost
DB_PORT=5432
DB_USER=your_username
DB_PASSWORD=your_pass
  1. Running the Application: Start the application in development:
npm start

Branching Strategy

  • Always branch out from main:
git checkout -b feat/your-feature-name
  • Use these prefixes for your branches:
Type Prefix
Feature feat/
Fix fix/
Docs docs/
Chore chore/

Commit Message Format

Use Conventional Commits:

git commit -m "feat(component): add navbar component"

Pull Request Process

  • Ensure your PR includes a clear title and description.

  • Link to any relevant issues.

  • Add screenshots or demos if applicable.

  • PRs should:

    • Pass lint and formatting checks
    • Be reviewed by at least one maintainer
    • Be rebased or merged cleanly with main

How to File a Bug

How to Request a Feature

Pull Request Checklist

Before submitting your pull request, please ensure the following:

  • Clear title and description that explain what the PR does
  • Follows the branching strategy (feat/, fix/, etc.) and uses Conventional Commits
  • Code is well-formatted
  • Includes tests or relevant usage examples, if applicable
  • All new/updated components are documented
  • Screenshots/demos included (for UI changes)
  • Linked to a related issue (if one exists)
  • PR is up-to-date with the main branch (git pull origin main before pushing)
  • Ready for review: tagged with appropriate labels (e.g., enhancement, bug, docs)
  • Reviewed and approved by at least one maintainer

Useful Resources

Code of Conduct

We follow the Contributor Covenant Code of Conduct. Be respectful, inclusive, and collaborative in all contributions.

Let’s build something great together!