Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 2.09 KB

Contributing to Odin

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

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 screenshots if possible

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, make sure to:

  • 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

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

Coding Standards

  • Use consistent coding style
  • Write descriptive commit messages
  • Include comments for complex logic
  • Add tests for new features
  • Update documentation for API changes

Style Guide

  • Use meaningful variable and method names
  • Keep methods focused and concise

Commit Signing

  • Ensure that your commits are GPG or SSH-signed
  • Unsigned commits may be rejected during review.

Documentation

  • Keep README.md updated
  • Update API documentation
  • Add inline code comments
  • Update examples when needed

Community

Questions?

Feel free to reach out to the maintainers if you have any questions. We're here to help!