Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 2 KB
Raw
Logo Omi3

We're thrilled that you're interested in contributing to Omi3! This document provides guidelines for contributing to the project.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct (to be added).

How to Contribute

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Reporting Bugs

Bugs are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps

Suggesting Enhancements

Enhancement suggestions are also tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • A clear and descriptive title
  • A detailed description of the proposed enhancement
  • An explanation of why this enhancement would be useful to most Omi3 users

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Follow the TypeScript and JavaScript styleguides
  • End all files with a newline

Style Guides

Git 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

TypeScript Styleguide

  • Prefer const over let
  • Use template literals instead of string concatenation
  • Use async/await instead of callbacks

Documentation Styleguide

  • Use Markdown
  • Reference methods and classes in markdown with the custom {} notation:
    • Class: {ClassName}
    • Method: {ClassName.methodName}

Thank you for contributing to Omi3!