AirQo-api/contributing.md

AirQo-Api contributing guide

Thank you for investing your time in contributing to our project!

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of each microservice, read the respective microservice READMEs:

• Airflow

• Analytics

• Auth-service

• Calibrate

• Data-mgt

• Device-monitoring

• Device-registry

• Device-status

• Device-uptime

• Exceedances

• Firebase

• GP-Model

• incentives

• kafka-connectors(bigquery-connector)

• kafka-connectors(measurement-source-connector)

• locate

• meta-data

• Predict

• View Here are some resources to help you get started with open source contributions:

• How to Contribute to Open Source

• Set up Git

• Collaborating with pull requests

Getting started

Issues

Create a new issue

If you spot a problem with any of our products, check the existing issues to establish if the problem has already been reported. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through the existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Note that you don't need to be assigned to this issue to work on it. Simply raise a PR that address it and add closes #issue-number in the PR description to automatically link your PR to the issue.

Make Changes

Make changes locally

1. Install Git LFS.

2. Fork the repository.

3. Create a working branch and start with your changes!

Style Guides

Basing on the framework and language you are using to develop any microservice, please ensure that you follow the Style Guide for that language accordingly.

Commit your update

Commit the changes, with a good commit message once you are happy with them.

Once your changes are ready, don't forget to test and self-review them to speed up the review process:zap:.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

• Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
• Don't forget to link PR to issue if you are solving one.
• Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, AirQo team members will review your proposal.
• We may ask for changes to be made before a PR can be merged. You can apply suggested changes and/or make any other changes in your fork, then commit them to your branch.
• As you update your PR and apply changes, mark each conversation as resolved.
• If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations :tada::tada:
The AirQo team thanks you :sparkles:.