Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (47 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 2.23 KB

Contributing to Abeille

Thank you for your interest in contributing to Abeille! This document provides guidelines and instructions for contributing.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.

How Can I Contribute?

Reporting Bugs

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

  • Use a clear and descriptive title
  • Describe the exact steps to reproduce the problem
  • Provide specific examples (including configuration files or commands used)
  • Describe the behavior you observed and why it is a problem
  • Include screenshots and animated GIFs if possible
  • Include details about your environment

Suggesting Enhancements

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

  • Use a clear and descriptive title.
  • Provide a detailed description of the suggested enhancement.
  • Explain why this enhancement would be useful to most users.
  • List some other applications where this enhancement exists, if applicable.

Your First Code Contribution

Unsure where to begin? Feel free to ask!

Pull Requests

  • Do not include issue numbers in the PR title
  • Follow the coding style and use linter
  • Document new code based on the project's documentation style
  • End all files with a newline

Styleguides

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

TypeScript Styleguide

  • Use 2 spaces for indentation
  • Prefer const over let
  • Use PascalCase for interfaces, types, and classes
  • Use camelCase for functions and variables
  • Add appropriate JSDoc comments for public APIs
  • Follow eslint configuration rules

Development Process

  1. Fork the repo and create your branch from master
  2. Install dependencies with bun install
  3. Make your changes
  4. Ensure your code lints with bun lint
  5. Submit your pull request

License

By contributing to Abeille, you agree that your contributions will be licensed under the project's license.