borneo

# Contributing to Borneo-IoT Project

Thank you for considering contributing to Borneo-IoT Project! We welcome contributions from everyone. This document outlines the process for contributing to our project.

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [How Can I Contribute?](#how-can-i-contribute)
  - [Reporting Bugs](#reporting-bugs)
  - [Suggesting Enhancements](#suggesting-enhancements)
  - [Contributing Code](#contributing-code)
- [Contributor License Agreement (CLA)](#contributor-license-agreement-cla)
- [Style Guidelines](#style-guidelines)
- [Commit Message Guidelines](#commit-message-guidelines)

## Code of Conduct

By participating in this project, you are expected to uphold our [Code of Conduct](.github/CODE_OF_CONDUCT.md). Please report unacceptable behavior to [oldrev@gmail.com](mailto:oldrev@gmail.com).

## How Can I Contribute?

### Reporting Bugs

Before you submit a bug report, please search the issue tracker to make sure the issue hasn't already been reported. If you find a similar issue, you can add a comment with additional information.

When reporting a bug, please include:

- A clear and descriptive title.
- A detailed description of the problem.
- Steps to reproduce the issue.
- The expected behavior.
- The actual behavior.
- Screenshots or videos if applicable.

### Suggesting Enhancements

Enhancement suggestions are welcome! Please provide as much detail as possible, including:

- A clear and descriptive title.
- A detailed description of the enhancement.
- Any relevant use cases or examples.

### Contributing Code

1. **Fork the Repository**: Click the "Fork" button at the top of the repository page to create your own copy of the project.

2. **Clone the Repository**: Clone your fork to your local machine.

   ```bash
   git clone https://github.com/oldrev/borneo.git
   ```

3. **Create a Branch**: Create a new branch for your feature or bug fix.

   ```bash
   git checkout -b feature-branch-name
   ```

4. **Make Changes**: Implement your changes or add your feature.

5. **Commit Changes**: Write clear and concise commit messages.

   ```bash
   git commit -m "Description of changes"
   ```

6. **Push Changes**: Push your branch to your fork on GitHub.

   ```bash
   git push origin feature-branch-name
   ```

7. **Open a Pull Request**: Go to the original repository and open a pull request with a clear title and description.

## Contributor License Agreement (CLA)

Before we can accept your contributions, you will need to sign our [Contributor License Agreement (CLA)](https://gist.github.com/oldrev/671a1c0068515e404d682a68f38e26ba). This ensures that the project can use your contributions while protecting your rights as a contributor.

We have configured a CLA bot to automate this process. When you open a pull request, the bot will check if you have signed the CLA. If not, it will guide you through the process.

## Style Guidelines

Please follow the existing code style and conventions used in the project. If you're unsure about anything, feel free to ask!

## Commit Message Guidelines

- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally.

Thank you for your contributions!