Skip to main content
Chitagá Tech is a community-driven open source project. We welcome contributions from everyone who wants to help build technology opportunities for Chitagá!

​
Getting Started

Before you begin, make sure you have:
  • Node.js (v18 or higher)
  • Git installed on your machine
  • A GitHub account
  • Basic knowledge of Astro, React, and TypeScript

​
Contribution Workflow

1

Fork the Repository

Visit the Chitagá Tech repository on GitHub and click the “Fork” button in the top-right corner. This creates your own copy of the project.
2

Clone Your Fork

Clone your forked repository to your local machine:
git clone https://github.com/YOUR-USERNAME/chitaga-tech.git
cd chitaga-tech
3

Install Dependencies

Install the project dependencies using npm:
npm install
4

Create a Feature Branch

Create a new branch for your contribution. Use a descriptive name:
git checkout -b feature/your-feature-name
Branch naming conventions:
  • feature/ - for new features
  • fix/ - for bug fixes
  • docs/ - for documentation changes
  • refactor/ - for code refactoring
5

Make Your Changes

Make your changes to the codebase. Follow our code style guidelines to ensure consistency.Run the development server to test your changes:
npm run dev
The site will be available at http://localhost:4321
6

Test Your Changes

Before committing, make sure:
  • The development server runs without errors
  • Your changes work as expected
  • The build completes successfully:
npm run build
7

Commit Your Changes

Stage and commit your changes with a clear, descriptive commit message:
git add .
git commit -m "Add: new hero animation component"
Good commit message examples:
  • Add: contact form validation
  • Fix: mobile menu not closing on link click
  • Update: hero section responsive layout
  • Refactor: extract ScrollAnimation to shared component
8

Push to Your Fork

Push your branch to your GitHub fork:
git push origin feature/your-feature-name
9

Create a Pull Request

  1. Go to the original Chitagá Tech repository
  2. Click “Pull Requests” and then “New Pull Request”
  3. Click “compare across forks”
  4. Select your fork and branch
  5. Fill in the PR template with:
    • A clear title
    • Description of your changes
    • Screenshots (if applicable)
    • Any related issues
  6. Click “Create Pull Request”

​
Pull Request Guidelines

​
PR Title Format

Use a clear, descriptive title that summarizes your changes:
  • Add contact form with email validation
  • Fix responsive layout on mobile hero section
  • Update services section with new content

​
PR Description

Include in your PR description:
  1. What - What changes did you make?
  2. Why - Why were these changes necessary?
  3. How - How did you implement the changes?
  4. Testing - How did you test the changes?

​
Review Process

  • A maintainer will review your PR
  • Address any requested changes
  • Once approved, your PR will be merged

​
Keeping Your Fork Updated

Keep your fork in sync with the original repository: 
# Add the original repository as upstream
git remote add upstream https://github.com/yamiddevofic/chitaga-tech.git

# Fetch the latest changes
git fetch upstream

# Update your main branch
git checkout main
git merge upstream/main

# Push to your fork
git push origin main

​
Need Help?

If you have questions or need help:
  • Check existing issues
  • Open a new issue with the “question” label
  • Reach out to the community through the contact form

​
Code of Conduct

Be respectful, inclusive, and constructive. We’re building this together for our community. Thank you for contributing to Chitagá Tech! 🚀

Build docs developers (and LLMs) love

Get started for freeTalk to us