contributing_guidelines

Last updated: 2024-09-17 21:09:16.313895 File source: link on GitLab

Table of contents

[[TOC]]

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

Please take a look at Device Management Service (DMS) README 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 Specification and Documentation Framework

How to report a bug?

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

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 a friend to help you reproduce what you need in order to confirm!

• Always search the Issue Tracker FIRST! 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.

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

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 request a new feature?

Feature proposals should be submitted to the issue tracker.

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

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

3. Always search the Issue Tracker FIRST! 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.

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

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

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

How to make a code contribution?

Finding an issue

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

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

Understand the development process

2. Familiarise yourself with the Specification and Documentation Framework.

3. Here you can find the development workflow used in NuNet platform.

Implementation

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

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

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

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