Contributing to Naas

We love contributions to Naas, big or small.

Thank you for your interest in contributing! We love community contributions. Contribution guidelines are listed below. If you're unsure about how to start contributing or have any questions even after reading them, feel free to ask us on Slack in the # 03_contributions or #general channel.

However, for those who want a bit more guidance on the best way to contribute to Naas, read on. This document will cover what we're looking for. By addressing the points below, the chances that we can quickly merge or address your contributions will increase.

Code of conduct

Please follow our Code of conduct in the context of any contributions made to Naas.

First-time contributors, welcome!

We welcome first-time contributors and are happy to guide you in getting started. In case of questions, just reach out to us via email or Slack!

Here is a list of easy good first issues to do.

Commit convention

We follow the Conventional Commits specification. It is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top.

In Naas, we use the following commit elements to communicate:

  1. fix: to patch a bug

  2. feat:to introduce a new feature

  3. docs: to document a feature or a fix

  4. style: to change the UX design of a feature

  5. refactor:to change the way a feature works

  6. test:to add unitary tests to the project

This commit convention applies to Naas and Naas drivers repository.

Areas for contribution

New templates

New drivers

New features

Documentation

Our goal is to keep our docs comprehensive and updated. If you would like to help us in doing so, we are grateful for any kind of contribution:

  • Report missing content

  • Fix errors in existing docs

  • Help us in adding to the docs