Sunbird UCI
  • Overview of Sunbird UCI
  • 📙Learn
    • UCI use cases
    • UCI for Education(Case study)
    • Tech Overview
      • Glossary
      • High-level Architecture Design
      • Design Principles
      • Standards
  • 🚀Use
    • Choose your Persona
    • Adopter - Install and use UCI
      • Pre-requisites, Installation Setup, Post Setup
      • Setting up your very first conversation
      • API Documentation
      • Data Exhaust and Analytics
      • Posthog Event
      • Whatsapp (Netcore)
      • Environment Variables
    • Developer - Contribute to UCI
      • UCI Basics
        • XMessage Specification
        • Transformers
          • ODK Transformer
            • Interactive-Messages
            • Media Messages
            • Location
          • Broadcast Transformer
        • Adapters
          • Firebase Notification Adapter
        • User Segment
        • Schema Overview
          • UCI Core Schema
            • XMessage Schema
            • Assessment DB Schema
          • UCI API Schema
      • Development environment
        • Backend Setup
        • Setting up IDE
        • Environment variable setup
        • Debug services
        • Build and Execute UCI
        • Frontend Setup (Admin Console)
        • Frontend Setup (PWA)
        • Transport Socket
      • API Documentation
        • Bot Setup APIs
        • History APIs
        • Direct Message APIs
        • Vault APIs
      • Database Schema
        • Cassandra Xmessage Database
        • Postgres Forms Database
        • Postgres User Analytics Database
        • Postgres Comms Database
      • Contribution Guide
        • Your first PR
        • Contribute an Adapter
        • Adapter Implementation
        • Create a Transformer
    • Contact the administrator
  • ✅Releases
    • Release V2
  • 🤝Engage
    • Software License
    • Acceptable Use Policy
    • Terms of Service
    • Source Code
    • Discussion Forum
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Use
  2. Developer - Contribute to UCI
  3. Contribution Guide

Your first PR

Pull requests with patches, improvements, new features are a great help.

Follow the steps to get your work included in the project.

1. Fork the project, clone your fork, and add the UCI-PWA remote:

# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/inbound.git

# Navigate to the cloned directory
cd inbound

# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/samagra-comms/inbound.git

2. Get the latest changes from upstream:

git checkout master
git pull upstream master

3. Create a new branch from the master/latest working branch to contain your changes. Best way is to call is to follow the type described in Git Commit Conventions stated above: /<description/scope/topic>

git checkout -b <topic-branch-name>

Example:

git checkout -b mike/buckets-undefined-index

Or

git checkout -b mike/fix

4. Commit your changes

5. Locally rebase the upstream master branch into your topic branch:

git pull --rebase upstream master

6. Push your topic branch up to your fork:

git push origin <topic-branch-name>

PreviousContribution GuideNextContribute an Adapter

Last updated 2 years ago

Was this helpful?

Commit your changes in logical chunks. Please adhere to Git Commit Conventions and Coding guidelines or your code is unlikely to be merged into the main project. Use Git's feature to tidy up your commits before making them public.

7. with a clear title and description against the master/latest branch.

🚀
interactive rebase
Open a Pull Request