Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (46 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 1.98 KB

Contributing to DMI CLI

Thank you for your interest in contributing to DMI CLI! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue with the following information:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Any relevant logs or screenshots
  • Your environment (OS, Go version, etc.)

Suggesting Features

We welcome feature suggestions! Please create an issue with:

  • A clear, descriptive title
  • A detailed description of the proposed feature
  • Any relevant examples or use cases
  • If possible, a sketch or mockup of the feature

Pull Requests

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Write or update tests as necessary
  5. Ensure all tests pass
  6. Submit a pull request

Development Setup

Please refer to the README.md file for instructions on setting up the development environment.

Coding Standards

Go

  • Follow the Go Code Review Comments
  • Use gofmt to format your code
  • Write meaningful comments and documentation
  • Write tests for your code

TypeScript/React

  • Follow the Airbnb JavaScript Style Guide
  • Use ESLint and Prettier for code formatting
  • Write meaningful comments and documentation
  • Write tests for your code

Commit Messages

  • 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 after the first line

License

By contributing to DMI CLI, you agree that your contributions will be licensed under the project's Apache License 2.0.