LogoLogo
WebsiteTechnical Discussions
Developer documentation
Developer documentation
  • Public Technical Documentation
    • device-management-service
      • main
        • actor
        • api
        • cmd
          • actor
          • cap
        • db
          • repositories
            • clover
        • dms
          • behaviors
          • jobs
          • node
          • onboarding
          • resources
        • docs
          • deployments
          • onboarding
          • private_network
        • executor
          • docker
          • firecracker
          • background_tasks
          • config
          • hardware
        • maint-scripts
        • network
          • libp2p
        • observability
        • specs
          • basic_controller
          • s3
          • volume
          • integration
        • tokenomics
        • types
        • utils
          • validate
      • release
        • actor
        • api
        • cmd
          • actor
          • cap
        • db
          • repositories
            • clover
        • dms
          • behaviors
          • hardware
          • jobs
          • node
          • onboarding
          • resources
        • docs
          • deployments
          • onboarding
          • private_network
        • executor
          • docker
          • firecracker
        • internal
          • background_tasks
          • config
        • maint-scripts
        • network
          • libp2p
        • observability
        • plugins
        • specs
        • storage
          • basic_controller
          • s3
          • volume
        • test
        • tokenomics
        • types
        • utils
          • validate
    • solutions
      • asi-node
        • main
          • demos
            • ocap_auth
              • ansible
              • videos
          • did-auth-use-scenarios
            • create-a-hosting-deployment
            • make-a-payment
            • manage-dids-and-ocaps
            • register-an-ai-agent
            • submit-a-compute-job
          • pilots
            • asi-create-authentication-poc
        • release
      • nunet-appliance
        • main
        • release
    • test-suite
      • main
        • cicd
          • tests
            • feature_environment
          • cli
          • dms-on-lxd
            • local
        • environments
          • development
          • feature
          • production
          • staging
        • infrastructure
          • cloud-init
          • dms-on-lxd
          • nginx
        • lib
        • stages
          • dependency_scanning
          • functional_tests
          • integration_tests
          • load_tests
          • regression_tests
          • security_tests_1
          • security_tests_2
          • security_tests_live
          • unit_tests
          • user_acceptance_tests
      • release
        • cicd
          • tests
            • feature_environment
          • cli
          • dms-on-lxd
            • local
        • environments
          • development
          • feature
          • production
          • staging
        • infrastructure
          • cloud-init
          • dms-on-lxd
          • nginx
        • lib
        • stages
          • dependency_scanning
          • functional_tests
          • integration_tests
          • load_tests
          • regression_tests
          • security_tests_1
          • security_tests_2
          • security_tests_live
          • unit_tests
          • user_acceptance_tests
    • team-processes-and-guidelines
      • main
        • best_practices
        • ci_cd_pipeline
        • community_feedback_process
        • contributing_guidelines
        • git_workflows
        • nunet_test_process_and_environments
        • secure_coding_guidelines
        • specification_and_documentation
        • team_process
          • a_project_management
          • b_ceremonies_artifacts
          • c_drum_buffer_rope
          • d_development_process
          • e_culture_rules
          • f_mr_review
        • vulnerability_management
          • devsecops_maturity_models
          • nunet_security_pipeline
          • secret_management
          • sop_security_mr_review
Powered by GitBook
On this page
  • Table of contents
  • Contributing guidelines
  • Before you get started
  • How to report a bug?
  • How to ask a question or report a non reproducible issue?
  • How to request a new feature?
  • How to make a code contribution?
  • How to initite a discussion?
Export as PDF
  1. Public Technical Documentation
  2. team-processes-and-guidelines
  3. main

contributing_guidelines

Previouscommunity_feedback_processNextgit_workflows

Last updated 10 hours ago

Last updated: 2025-05-15 01:10:21.044512 File source:

Table of contents

Contributing guidelines

This page contains guidelines for the community to contribute in NuNet's development. We appreciate any kind of contribution, including:

  • Bug reporting and fixes

  • Documentation improvements

  • Code contributions & improvements

  • New features

  • Testing etc

Before you get started

How to report a bug?

Note: Bugs should be reproducible! Include detailed steps on how to reproduce the problem, along with any error messages. Screenshots and GIFs are helpful too! If you are unsure if what you are experiencing is reproducible, reach out to our community and ask help to reproduce what you need in order to confirm!

The boxes in template have some prompters to help you on what should be included. The template can be populated and edited as needed.

  • Add the ~type::bug label to your issue!

How to ask a question or report a non reproducible issue?

  • Add the ~type::question label to your issue!

How to request a new feature?

  1. Keep it simple! Keep feature proposals as small and simple as possible, complex ones might be edited to make them small and simple.

The boxes in template have some prompters to help you on what should be included. The template can be populated and edited as needed.

  1. Add the ~type::feature label to your issue!

How to make a code contribution?

Finding an issue

Apply the filter with ~good-first-issue label to see issues suitable for those who are new to the project.

Understand the development process

Implementation

  1. After submitting the merge request, verify that all CI/CD pipeline stages are running successfully. Fix the merge request if necessary.

How to initite a discussion?

  • Add the ~type::discussion label to your issue!

Please take a look at Device Management Service (DMS) to get an overall understanding of the project architecture and the underlying concepts. This will also tell you basics of how to get started with using the DMS functionality.

It is recommended that you familiarize yourself with the codebase. Read the associated documentation specified in the README files present in each directory. To understand how the README files are structured refer to the

Bug reports should be submitted to the on the appropriate repository. For example, if the bug about Device Management Service (DMS), use the .

! It’s likely someone caught this before you, or already reported something similar, and it will save time and effort. If you find an existing issue, show your support with an award emoji and/or join the discussion.

! This template can be chosen while creating a new issue. See below for an illustrative screenshot.

Questions should be submitted to the on the appropriate repository. For example, if the question is about Device Management Service (DMS), use the .

! It's likely that someone already reported something similar, and it will save time and effort. If you find an existing issue, show your support with an award emoji and/or join the discussion.

Use the ! This template can be chosen while creating a new issue. See below for an illustrative screenshot.

Feature proposals should be submitted to the .

Refer to the for steps to be followed while suggesting a change to the existing functionality.

! It’s likely someone already reported something similar, and it will save time and effort. If you find an existing issue, show your support with an award emoji and/or join the discussion.

! This template can be chosen while creating a new issue. See below for an illustrative screenshot.

Search the to look at already created issues ready for development.

Familiarise yourself with the .

you can find the development workflow used in NuNet platform.

Refer to for the process to be followed while implementing a new feature or functionality.

Create a merge request with the contributed code, filling out all requested information accordingly to the .

All code and contributions have to include appropriate documentation updates, corresponding to the code changes, as explained in README file.

To start a conversation or to share your thoughts on a specific topic, a new issue should be submitted to the on the appropriate repository. For example, if the question is about Device Management Service (DMS), use the .

! It's likely that someone already reported something similar, and it will save time and effort. If you find an existing issue, show your support with an award emoji and/or join the discussion.

Use the ! This template can be chosen while creating a new issue. See below for an illustrative screenshot.

README
Specification and Documentation Framework
issue tracker
DMS issue tracker
Always search the Bug Tracking Board FIRST
Use the Bug Issue Template
issue tracker
DMS issue tracker
Always search the Feedback Board FIRST
Questions template
issue tracker
Update Procedure
Always search the Feedback Board FIRST
Use the Feature Proposal Issue Template
Issue Tracker
Specification and Documentation Framework
Here
these steps
merge request template
Specification and Documentation
issue tracker
DMS issue tracker
Always search the Feedback Board FIRST
Discussion template
link on GitLab
Contributing guidelines
Before you get started
How to report a bug?
How to ask a question or report a non reproducible issue?
How to request a new feature?
How to make a code contribution?
Finding an issue
Understand the development process
Implementation
How to initite a discussion?