Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 2.29 KB

Contributing to kcli

Thank you for considering contributing to kcli! Your help is greatly appreciated. Here are some guidelines to help you get started.

How to Contribute

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Before creating enhancement suggestions, please check the Issues as you might find out that you don't need to create one.
  • If the enhancement suggestion is not listed, open a new issue and describe the enhancement in detail.

Pull Requests

  • Fork the repository.
  • Create your feature branch (git checkout -b feature/AmazingFeature).
  • Commit your changes (git commit -m 'Add some AmazingFeature').
  • Push to the branch (git push origin feature/AmazingFeature).
  • Open a pull request in the main repository.

Coding Standards

  • Follow Rust's coding standards and best practices.
  • Write clear and descriptive commit messages.
  • Ensure your code passes all tests and lint checks before submitting.

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.

Rust Style Guide

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to email@example.com.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to kcli!