Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (68 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

100 lines (68 loc) · 2.66 KB

Contributing to EmbeddedLayers Projects

Thank you for your interest in contributing to EmbeddedLayers! Our engineering team welcomes contributions from the community.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check existing issues as our team might already be working on a fix. When you create a bug report, please include:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • System information (OS, versions, etc.)
  • Any relevant logs or screenshots

Our QA team reviews all bug reports weekly during our sprint planning sessions.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. Our product team evaluates all feature requests based on:

  • Alignment with our roadmap
  • Impact on existing users
  • Technical feasibility
  • Resource requirements

Pull Requests

  1. Fork the repository and create your branch from main
  2. Follow our coding standards (see below)
  3. Ensure all tests pass
  4. Update documentation as needed
  5. Submit a pull request with a clear description

Our engineering team reviews PRs within 2-3 business days.

Development Process

Code Review

All submissions require review from our team:

  • Code quality and standards compliance
  • Security review for sensitive changes
  • Performance impact assessment
  • Documentation completeness

Testing Requirements

  • Unit tests for all new functionality
  • Integration tests where applicable
  • Performance benchmarks for critical paths
  • Security scanning for dependencies

Coding Standards

Python (MCP Analytics)

  • Follow PEP 8
  • Use type hints
  • Docstrings for all public methods
  • Maximum line length: 100 characters

R (PDai Packages)

  • Follow tidyverse style guide
  • Use roxygen2 for documentation
  • Consistent naming conventions
  • Comprehensive examples

Communication

Questions and Support

Response Times

Our team typically responds:

  • Critical security issues: Within 24 hours
  • Bug reports: 2-3 business days
  • Feature requests: Weekly review
  • Pull requests: 2-3 business days

Recognition

Contributors who make significant improvements may be:

  • Listed in our CONTRIBUTORS file
  • Mentioned in release notes
  • Invited to our technical advisory discussions

License

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

Thank you for helping make EmbeddedLayers better! Our team appreciates your time and effort.

Last updated by the EmbeddedLayers Engineering Team