Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (51 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 2.5 KB
Raw

Contributing to Lodestone

First off, thank you for considering contributing to Lodestone! It's people like you that make Lodestone such a great tool.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include logs if relevant

Suggesting Enhancements

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

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead
  • Explain why this enhancement would be useful

Pull Requests

  • Fork the repo and create your branch from main
  • If you've added code that should be tested, add tests
  • If you've changed APIs, update the documentation
  • Ensure the test suite passes
  • Make sure your code lints
  • Issue that pull request!

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

Rust Styleguide

  • Follow the Rust Style Guide
  • Run cargo fmt before committing
  • Ensure cargo clippy passes without warnings
  • Document all public functions and types

Documentation Styleguide

  • Use Markdown for documentation
  • Reference functions and types using backticks
  • Include examples for non-obvious functionality

Additional Notes

Issue and Pull Request Labels

  • bug - Confirmed bugs or reports likely to be bugs
  • enhancement - Feature requests
  • documentation - Documentation improvements
  • good first issue - Good for newcomers
  • help wanted - Extra attention is needed

Thank you for contributing to Lodestone! 🚀