CONTRIBUTING.md

Table of Contents

• Development Environment Setup
• Codebase Structure
• The Workflow
  • Nightly Checkouts and Pulls
• Coding Standards
• Writing Documentation
• Testing
  • Unit Testing
  • Contineous Integration
• Performance Profiling

Contributing to FEAGI

We are excited to see your interest in contributing to FEAGI! The FEAGI community values your contributions and we look forward to having you as a long-term member.

Getting Started

---

Development Environment Setup

Codebase Structure

The Workflow

Nightly Checkouts and Pulls

Coding Standards

FEAGI Python code contributions should adhere to the standards described in PEP 8. All Python code contributions should be documented in accordance with PEP 257 conventions. Static code analysis tools like Pylint and flake8 provide configurable, automated solutions for checking and enforcing PEP compliance. The feagi repository continuous integration (CI) workflow uses Pylint to analyze Python code contributions. A CI workflow job will fail if Pylint code analysis results in a code quality score below a defined threshold.

Writing Documentation

Testing

Unit Testing

Continuous Integration

Performance Profiling