LogoLogo
CommunityLicense
1.0.0
1.0.0
  • 🏠Home
  • 🏢Architecture
  • 📋Registration
    • Registration Interfaces
      • Mobile Registration App
      • Self Service Portal
      • API Interface
    • ID Verification
    • Registry
  • 🅿️Program Management
    • Eligibility Assessment
    • Enrolment
    • Deduplication
    • Disbursement Cycles
    • Entitlement
    • Verifiable Credentials
  • 💵Payment Management
    • Payment Cycles
    • Payment Batches
    • Payment Manager
    • Payment Types
      • In Account
      • Voucher
      • Cash
      • In Kind
    • Payment Rails
    • Accounting
      • Accounting
      • Reconciliation
      • Reports
  • Notifications
  • 📊Monitoring and Reporting
  • ⛓️Workflows
    • Cash grant scenario
    • On-Demand Assistance
  • 🔗Integrations
    • Mojaloop Integration
    • MOSIP Integration
      • ODK MTS Connector
      • Registry MTS Connector
      • Integration with e-Signet
  • ↔️API
  • ⚒️Testing
  • 👥Community
    • Contributing
    • Code of Conduct
  • 📗License
  • Guides
    • 📔How-To Guides
      • Create Program
      • Configure Proxy Mean Test
      • Create User and Assign Role
      • Create ODK Form
      • Create Portal Form
      • Provide Form Access to Field Agent
      • Download Form on ODK Collect
      • Register Offline
      • Self Register Online
      • Create MTS Connector
        • Create ODK MTS Connector
        • Create OpenG2P Registry MTS Connector
      • Enrol Registrants into Program
      • Create and Approve Disbursement Cycle
      • Prepare and Send Payment
      • Create Payment Manager under Program
      • Create Payment Manager Types
        • Create Payment Hub EE Payment Manager
        • Create Payment Interoperability Layer Payment Manager
        • Create Default Payment Manager
      • Create Eligibility Manager under Program
      • Create Eligibility Manager Types
        • Create Default Eligibility Manager
        • Create ID Document Eligibility Manager
        • Create Phone Number Eligibility Manager
      • Create Deduplication Manager under Program
      • Create Deduplication Manager Types
        • Create ID Deduplication Manager
        • Create Phone Number Deduplication
      • Create Notification Manager under Program
      • Create Notification Manager Types
        • Create SMS Notification Manager
        • Create Email Notification Manager
        • Create Fast2SMS Notification Manager
      • Send Notification to Individual Registrants
      • Configure ID Types
      • Map ODK Form
      • Integrate with MOSIP e-Signet
      • Map Self Service Portal Form
      • Install WireGuard App And Activate Tunnel
      • Install SmartScanner App
      • Submit Reimbursement Using the Service Provider Portal
    • 📙Documentation Guides
      • Creating Diagrams
      • Writing Guidelines For How-To Guides
    • 👩‍💻👩💻 👩💻 👩💻 👩💻 👩💻 Developer Zone
      • Getting Started
      • Technology Stack
      • About Github Repositories
        • openg2p-registry
        • openg2p-program
    • 📘Deployment Guide
      • Deployment on Kubernetes
        • K8s Cluster Requirements
        • K8s Cluster Setup
        • Rancher Server Setup
        • NFS Server Setup
        • SSL Certificates using Letsencrypt
      • Access to Deployed Setup
      • Post Install Configuration
      • Packaging OpenG2P Docker
Powered by GitBook
LogoLogo

Copyright © OpenG2P. This work is licensed under Creative Common Attribution (CC-BY-4.0) International license unless otherwise noted.

On this page
  • Introduction
  • Issues
  • Code contributions
  • Coding conventions
  • Documentation contributions
  • Versioning of modules
  • Branching and tagging conventions
Export as PDF
  1. Community

Contributing

PreviousCommunityNextCode of Conduct

Last updated 2 years ago

Introduction

OpenG2P is a collaborative effort of several contributors. We welcome contributions to the OpenG2P Project.

Issues

Raise bugs/issues/tasks on GitHub Issues of individual repositories.

All the issues and tasks are tracked using .

Code contributions

To contribute code to the OpenG2P project, follow the steps given below:

  1. Create an issue on Github related to your task.

  2. Fork the corresponding repository.

  3. Commit your changes in your forked repo. Make sure the issue id of GitHub is mentioned in square braces, e.g. [#6] Minor changes to fix the bug.

  4. Raise a Pull Request (PR) on the appropriate branch. In general, it is safe to send PRs to develop branch of a repo.

  5. The PRs shall be reviewed by the technical team and merged after approval.

Coding conventions

Documentation contributions

Versioning of modules

OpenG2P release will follow Semantic Versioning. For GitHub branches and tags versions, refer to the sections below.

Branching and tagging conventions

For Odoo module repositories, a prefix of Odoo version is added to the branch name, e.g. 15.0-1.0.0, 15.0-develop.Within a branch, multiple Git tags may be created like 15.0-1.0.0-rc1, 15.0-1.0.0-rc2 etc.

For non-Odoo module repositories, you should find a develop branch in the repo where in-progress work may be checked-in.

For releases, a release branch is forked out of the develop branch and subsequently, release specific check-ins like bug fixes are made on this branch. For the final release, this branch is Git tagged, frozen (no further check-ins allowed) and merged into the develop branch. Thus, all the changes related to the release are available in develop for further development. The recommended Github tagging convention for a final release is to have a prefix v or release before the version number. For example, v15.0.1.0.0, release-15.0.1.0.0, v1.0.0, release-1.0.0

For Odoo modules, follow the

For non-Odoo Python code, follow .

The documentation of the project is available as .md files in the . To highlight a correction or request for additional documentation, raise a GitHub Issue on the repository. To contribute to the documentation follow the steps given under .

For Odoo modules, follow the . To indicate the maturity of a version (like alpha/beta etc.) use development_status field in the __manifest__.py file as described .

For Non-Odoo modules, follow .

👥
Jira
Odoo Coding Guidelines.
PEP 8 – Style Guide for Python Code
Odoo Versioning
here
Semantic Versioning
Documentation repository
Code contributions