Signet
GitHubCommunityWhat's NewChatBot
  • 🌐eSignet
  • 🔍Overview
    • ✨Features
      • Signup Portal
    • âš–ī¸Principles
    • 📏Standards & Security
    • 📜License
  • đŸ’ģDevelop
    • đŸĻžTechnology
      • đŸ“ĻTechnology Stack
      • âš™ī¸Components - eSignet
      • đŸ¤ŗComponents - Signup Portal
      • 📲API
    • âš™ī¸Configure eSignet
      • ACR
      • Claims
      • .well-known
        • jwks.json
        • oauth-configuration
        • openid-configuration
  • 🎮Test
    • đŸ•šī¸Try It Out
      • Using Mock Data
      • Register Yourself
      • Integrate with eSignet
    • 👨‍đŸ’ģEnd User Guide
      • Health Portal
        • Login with Biometrics
        • Login with Password
        • Login with OTP
        • Login with QR code (Inji)
        • Knowledge Based Identification
        • Signup and Login with OTP for Verified Claims
    • 🧩Integration Guides - eSignet
      • Authenticator Plugin
      • Key Binder Plugin
      • Audit Plugin
      • Digital Wallet
        • Credential Holder
        • Wallet Authenticator
      • Relying Party
    • 🔐Integration Guide - Signup Portal
      • Identity Verifier Plugin
      • Profile Registry Plugin
      • Integration with eSignet portal
  • đŸ› ī¸Deploy
    • â›´ī¸Deployment Architecture
      • On-Prem Installation Guidelines
    • ⚓Local Deployment
      • Mock Identity System
      • Mock Relying Party
  • 🔌Interoperability
    • MOSIP
    • Inji
    • OpenCRVS
  • 🚀Roadmap and Releases
    • đŸ›Ŗī¸Roadmap
      • Roadmap 2025
      • Roadmap 2024
    • 📖Releases
      • v1.5.1
        • Test Report
      • v1.5.0
        • Test Report
      • v1.4.2
      • v1.4.1
        • Test Report
      • v1.4.0
        • Test Report
      • v1.3.0
        • Test Report
      • v1.2.0
        • Test Report
      • v1.1.0
        • Test Report
      • v1.0.0
        • Test Report
      • v0.9.0
        • Test Report
  • 🤝Community
    • Code Contribution
    • Code of Conduct
  • 📌General
    • 📚Resources
    • ❓FAQs
    • 💡Glossary
Powered by GitBook

Copyright Š 2021 MOSIP. This work is licensed under a Creative Commons Attribution (CC-BY-4.0) International License unless otherwise noted.

On this page
  • Overview
  • Repositories
  • Setup your development machine
  • Code changes

Was this helpful?

Edit on GitHub
Export as PDF
  1. Community

Code Contribution

Last updated 4 months ago

Was this helpful?

Overview

The below recommended Github workflow allows developers to submit code and documentation contributions to eSignet open-source repositories.

Repositories

Setup your development machine

  1. Fork repository of interest.

  2. Clone the fork to your local machine. E.g.:

    $ git clone https://github.com/<your_github_id>/esignet.git
  3. Set the upstream project as the original from where you forked. E.g.:

    $ cd esignet
    $ git remote add upstream https://github.com/mosip/esignet.git
  4. Make sure you never directly push upstream.

    $ git remote set-url --push upstream no_push
  5. Confirm the origin and upstream.

    $ git remote -v

Code changes

  1. Create a new issue in GitHub.

    1. Follow the issue template provided.

    2. Please provide as much information as possible.

    3. If you want to develop a new feature, please elaborate on the idea and discuss the design before starting development.

  2. In your local repository, fetch the upstream.

$ git fetch upstream

3. On your local repo, switch to a branch if you are working on an older release (like the 1.0.0 branch) or stay in main/develop the branch.

$ git checkout upstream/<branch> 

You will get a warning from git. Don't worry, our next step will take care of this warning.

4. Create a new issue branch with the name of the issue.

$ git switch -c issue-<issue number>

5. Make sure you are up-to-date with the upstream repo.

$ git pull upstream <branch> 

You should do this quite often to ensure you are up to date.

$ git commit -m "[#1234] Adding new upload feature in eSignet service"

7. Once again, ensure you are up-to-date with the upstream repo as it may have moved forward.

$ git pull upstream <branch> 

8. Build and test your code. Make sure to follow the coding guidelines. Provide unit test cases for the changes you have built.

9. Push to your forked repo (origin).

$ git push --set-upstream origin issue-<issue number>

10. On your forked remote repository from GitHub, create a pull request using the Contribute button. Direct the pull-request to main or any specific branch upstream.

Most often it's the same branch in the upstream (as in Step 3).

11. Make sure the automatic tests on GitHub for your pull request pass.

6. Now feel free to make the change in the code or documentation. Reach out to for any queries. Once done with the work, commit your changes by referring to the Issue ID in the commit message. Eg:

12. Reviewers shall review the pull request. Reach out to the for a faster response.

🤝
our community
community
GitHub - mosip/esignet: Open ID based e-Signet service for large scale verification & authentication.GitHub
GitHub - mosip/esignet-mock-services: Repository contains mock implementation of auth for e-signetGitHub
GitHub - mosip/esignet-signupGitHub
GitHub - mosip/esignet-plugins: Repository hosting source code for esignet java runtime dependencies pluginsGitHub
Logo
Logo
Logo
Logo