Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
86 commits
Select commit Hold shift + click to select a range
d1abe2e
Chore: Initial repository skeleton for the measurement module
JobCollins Oct 24, 2025
59d663d
Chore: Skeleton (repo, CI, lint, tests)
JobCollins Oct 24, 2025
f6db534
Feature: Library Integration Layer
JobCollins Oct 27, 2025
d52b62b
Feature: Metrics Engine with Intersectionality
JobCollins Oct 27, 2025
8b6b31a
Feature: Statistical Validation Module
JobCollins Oct 28, 2025
9db340c
Merge: Merge branch 'metric_engine' implementing the metric engine an…
JobCollins Oct 28, 2025
7108865
Feature: Implement Workflow Integration (Phase 4)
JobCollins Oct 30, 2025
92e8751
Feature: Phase 5 — E2E system tests, demo notebook, and docs polish; …
JobCollins Oct 30, 2025
c11e545
Chore: Running the Demo.ipynb notebook
JobCollins Oct 30, 2025
aff4ac9
Merge: Merge branch 'workflow_integration implementing validation of …
JobCollins Oct 30, 2025
482f8d6
Phase 5: Testing & Demo Integration
JobCollins Oct 30, 2025
8eed298
Chore: Finalize Measurement Module v0.1.0 — added ADR-001 architectur…
JobCollins Oct 30, 2025
3c2aea8
Merge: Merge branch 'workflow_integration added ADR-001 architecture …
JobCollins Oct 30, 2025
21ce56f
Chore: Add file to ignore
JobCollins Oct 30, 2025
31936cc
Chore: Add file to ignore
JobCollins Oct 30, 2025
3d05b08
Chore: scaffold Phase 0 structure for Pipeline Module
JobCollins Oct 31, 2025
72f6cd4
Feature: core architecture and bias detection engine
JobCollins Oct 31, 2025
6138040
Docs: update README and CHANGELOG for v0.2.0 (Pipeline Module Phase 1–2)
JobCollins Oct 31, 2025
11d86f3
Merge pull request #1 from JobCollins/pipeline_module
JobCollins Oct 31, 2025
cf01072
Feature: complete Phase 3–4 with transformer registry, CLI integratio…
JobCollins Oct 31, 2025
e13fae7
Docs: updated the CHANGELOG and README files
JobCollins Oct 31, 2025
96049b2
Feature: add CLI end-to-end system test and programmatic demo notebook
JobCollins Oct 31, 2025
f5a180b
Docs: Updated CHANGELOG and README
JobCollins Oct 31, 2025
d43e126
Merge: Merge Pipeline Module branch into main (Phases 0–5 complete)
JobCollins Oct 31, 2025
76ad2ee
Feature: fairness-aware training components and tests
JobCollins Nov 1, 2025
fde3daf
Docs: Updated README and CHANGELOG docs with latest changes
JobCollins Nov 1, 2025
7a3f5b6
Chore: Re-run to check tests
JobCollins Nov 1, 2025
d194aa6
Merge: integrate training_module branch into main
JobCollins Nov 1, 2025
8cfb576
Housekeeping: Codebase improvement
JobCollins Nov 13, 2025
173475a
BugFix: Measurement Module
JobCollins Nov 13, 2025
bbb22d4
BugFix(training): address Training Module gaps and improve test coverage
JobCollins Nov 19, 2025
3c16a6f
BugFix(monitoring): Address critical gaps in Monitoring Module
JobCollins Nov 19, 2025
3de4188
Chore: Update README file
JobCollins Nov 19, 2025
d3b0709
Chore: Version Update on README
JobCollins Nov 19, 2025
091bef1
Feature: Integrate toolkit modules into unified end-to-end workflow
JobCollins Nov 19, 2025
d0796f1
BugFix: Align version to 0.5.0 and fix entry point script for editabl…
JobCollins Nov 19, 2025
9d6d765
BugFix: Lint Errors fix
JobCollins Nov 19, 2025
b6bbcc7
BugFix: resolve intersectional analysis bug and improve test suite re…
JobCollins Nov 19, 2025
fe2a660
Docs: Draft Documentation for the toolkit
JobCollins Nov 19, 2025
fe884b0
BugFix: make artifact name unique using github.run_id to avoid 409 co…
JobCollins Nov 19, 2025
0e1a660
BugFix(ci): make uploaded artifact name unique by including run attempt
JobCollins Nov 20, 2025
2b7a099
Feature: Integrate fairness toolkit into recruitment model training s…
JobCollins Jan 14, 2026
9ae3dd7
Chore: Refactor(reporting): move report I/O and data preparation into…
JobCollins Jan 14, 2026
3723703
Chore: Changelog and ReadMe update
JobCollins Jan 14, 2026
1dcc2d4
Merge pull request #2 from JobCollins/report_improvement
JobCollins Jan 14, 2026
bbb7098
Feature: Add PyPI package metadata and stabilize public APIs for prod…
JobCollins Jan 15, 2026
752a522
Feature: Implement configuration file discovery and environment varia…
JobCollins Jan 15, 2026
ffcc1cd
Chore: docs: Add API reference and integration guide (Phase 4)
JobCollins Jan 16, 2026
8003735
Chore: docs: Add versioning strategy and backward compatibility polic…
JobCollins Jan 16, 2026
756cef2
Feature: : Add installation, API, and compatibility test suites (Phas…
JobCollins Jan 16, 2026
e0221ca
Test: tests for detector stub implementations
JobCollins Jan 18, 2026
1d1fe74
Test: Add comprehensive test coverage for integration/reporting.py
JobCollins Jan 18, 2026
8fdef44
Test: Add comprehensive tests for Aequitas adapter, bootstrap, and CLI
JobCollins Jan 19, 2026
54a622f
Test: Add Phase 4 test coverage for CLI commands and dashboard
JobCollins Jan 19, 2026
215bf59
Test(fix) : fix variable scoping in pipeline command tests
JobCollins Jan 21, 2026
b05ed52
Feature: Documentation and Benchmarks
JobCollins Jan 21, 2026
921916b
Fix(Lint): Fix black lint error by upgrading the Python version
JobCollins Jan 21, 2026
6cc9c22
Fix(install)
JobCollins Jan 21, 2026
5e743be
Fix(install)
JobCollins Jan 21, 2026
6248b3e
Fix(Python Version): Version not found for Windows
JobCollins Jan 21, 2026
9fccc24
Chore: Restoring requirements.txt
JobCollins Jan 21, 2026
a93a189
CI: Rerun workflow
JobCollins Jan 21, 2026
95f778b
CI: Artifact naming
JobCollins Jan 21, 2026
9e59751
CI(Windows): Unicode issue
JobCollins Jan 21, 2026
e802c90
Chore: projet release and maintenance tasks
JobCollins Jan 22, 2026
43d2efb
Feature: fix optional dependency imports and enhance error handling
JobCollins Jan 24, 2026
a51b553
Feature: Add security infrastructure, performance testing, structured…
JobCollins Jan 24, 2026
fa49964
Chore: Removing Install Dependencies Error
JobCollins Jan 24, 2026
6a3a11d
Release: prepare release v0.5.4 with TestPyPI support
JobCollins Jan 24, 2026
f97f959
Bugfix: correct dependabot.yml configuration
JobCollins Jan 24, 2026
2bb880e
Fix test coverage and security workflow issues
JobCollins Jan 24, 2026
aac7005
Fix test coverage and security workflow issues
JobCollins Jan 24, 2026
f1528a2
Fix: duplicate step ID in release workflow
JobCollins Jan 24, 2026
5e061cf
Chore: Migrate PyPI package name from fairness-pipeline-dev-toolkit t…
JobCollins Jan 26, 2026
1cbb401
Fix documentation build: add linkify-it-py dependency
JobCollins Jan 26, 2026
152b3ca
Chore: Docs & gitignore updates
JobCollins Jan 26, 2026
5b710d3
Feature: Add mae_parity_difference to FairlearnAdapter and AequitasAd…
JobCollins Jan 27, 2026
cd1749c
Feature: Add complete Training Module demo notebook
JobCollins Jan 27, 2026
c4223b7
Release: Bump version to 0.6.1
JobCollins Jan 27, 2026
a56eb34
Release: v0.6.2
JobCollins Feb 3, 2026
82f278a
Chore: Publish to PyPI
JobCollins Feb 3, 2026
b0a6662
Bump version to 0.6.3
JobCollins Feb 3, 2026
d36b370
Bump version to 0.6.5; update changelog
JobCollins Feb 3, 2026
172fd90
Fix: Documentation Page
JobCollins Feb 3, 2026
d96f18b
Docs: Deploy docs configuration
JobCollins Feb 3, 2026
ebd8737
chore(deps): bump actions/checkout from 4 to 6
dependabot[bot] Feb 3, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Binary file added .DS_Store
Binary file not shown.
331 changes: 331 additions & 0 deletions .github/FEEDBACK_REVIEW_PROCESS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,331 @@
# Feedback Review Process

This document outlines the process for reviewing and acting on user feedback for the Fairness Pipeline Development Toolkit.

---

## Overview

The feedback review process ensures that user input is:
- Acknowledged promptly
- Categorized appropriately
- Prioritized based on impact and feasibility
- Tracked and addressed systematically
- Communicated back to the community

---

## Process Steps

### 1. Submission and Acknowledgment

**Timeline**: Within 48 hours

**Actions**:
- All feedback submissions (issues, discussions, etc.) are acknowledged
- Initial triage label is applied
- Feedback is added to tracking system

**Responsible**: Maintainers

### 2. Triage

**Timeline**: Within 1 week

**Actions**:
- Categorize feedback:
- Bug
- Feature Request
- Documentation
- Usability
- Performance
- General Feedback
- Assign priority:
- **Critical**: Security issues, data corruption, major functionality broken
- **High**: Significant bugs, highly requested features, major usability issues
- **Medium**: Moderate bugs, useful features, documentation gaps
- **Low**: Minor issues, nice-to-have features, edge cases
- Add appropriate labels
- Link related issues/discussions

**Responsible**: Maintainers

### 3. Review and Assessment

**Timeline**: 1-2 weeks (depending on priority)

**Actions**:
- Technical feasibility assessment:
- Implementation complexity
- Dependencies and conflicts
- Performance implications
- Breaking changes
- Impact assessment:
- Number of users affected
- Workflow disruption
- Alignment with project goals
- Community input:
- Gather feedback from discussions
- Check for duplicate requests
- Assess community support

**Responsible**: Maintainers + Community

### 4. Decision

**Timeline**: 2-4 weeks

**Outcomes**:

**For Bugs**:
- **Critical/High**: Scheduled for next patch/minor release
- **Medium**: Added to backlog, addressed in next minor release
- **Low**: Tracked, addressed when resources available

**For Features**:
- **High Priority**: Added to next minor/major release roadmap
- **Medium Priority**: Added to roadmap for future consideration
- **Low Priority**: Tracked for future releases

**For Documentation**:
- Updated in next documentation cycle
- Added to documentation backlog if extensive

**For Usability/Performance**:
- Investigated and optimized in next release
- Added to improvement backlog

**Responsible**: Maintainers

### 5. Implementation Planning

**Timeline**: Before release planning

**Actions**:
- Create implementation plan
- Assign to release milestone
- Break down into tasks
- Estimate effort
- Identify dependencies

**Responsible**: Maintainers

### 6. Implementation

**Timeline**: Per release schedule

**Actions**:
- Implement changes
- Write tests
- Update documentation
- Create pull request
- Review and merge

**Responsible**: Maintainers + Contributors

### 7. Follow-up

**Timeline**: After release

**Actions**:
- Notify original submitter
- Update issue/discussion with resolution
- Credit contributors in release notes
- Close issue/discussion

**Responsible**: Maintainers

---

## Priority Guidelines

### Critical Priority

**Criteria**:
- Security vulnerabilities
- Data corruption or loss
- Major functionality completely broken
- Blocks all users from using core features

**Response Time**: 24 hours
**Resolution Time**: Next patch release

### High Priority

**Criteria**:
- Significant bugs affecting many users
- Highly requested features (5+ upvotes)
- Major usability issues
- Performance degradation > 50%

**Response Time**: 48 hours
**Resolution Time**: Next minor release

### Medium Priority

**Criteria**:
- Moderate bugs with workarounds
- Useful features with community support
- Documentation gaps
- Minor usability issues
- Performance improvements

**Response Time**: 1 week
**Resolution Time**: Next minor/major release

### Low Priority

**Criteria**:
- Edge cases
- Nice-to-have features
- Minor documentation improvements
- Cosmetic issues

**Response Time**: 2 weeks
**Resolution Time**: Future releases

---

## Feedback Categories

### Bug Reports

**Review Focus**:
- Reproducibility
- Impact on users
- Workarounds available
- Root cause analysis

**Decision Factors**:
- Severity of impact
- Frequency of occurrence
- Ease of reproduction
- Fix complexity

### Feature Requests

**Review Focus**:
- Use case clarity
- Community support
- Alignment with project goals
- Implementation feasibility

**Decision Factors**:
- Number of users who would benefit
- Implementation complexity
- Maintenance burden
- Fit with project scope

### Documentation

**Review Focus**:
- Clarity of issue
- Impact on user experience
- Scope of changes needed

**Decision Factors**:
- User confusion level
- Documentation gaps
- Update complexity

### Usability

**Review Focus**:
- User experience impact
- Frequency of issue
- Workflow disruption

**Decision Factors**:
- Number of users affected
- Improvement potential
- Implementation effort

### Performance

**Review Focus**:
- Performance degradation
- Scalability concerns
- Resource usage

**Decision Factors**:
- Impact on typical use cases
- Optimization potential
- Implementation complexity

---

## Tracking and Communication

### Issue Tracking

- All feedback is tracked in GitHub Issues
- Labels indicate category and priority
- Milestones track release planning
- Projects organize related work

### Communication

- Regular updates in issue comments
- Status updates in discussions
- Release notes for completed work
- Roadmap updates for planned features

### Metrics

Track:
- Time to acknowledgment
- Time to resolution
- Feedback categories
- Priority distribution
- Community engagement

---

## Review Schedule

### Weekly

- Triage new submissions
- Update issue status
- Respond to questions

### Monthly

- Review priority assignments
- Assess community feedback
- Update roadmap
- Plan next release

### Quarterly

- Review feedback trends
- Assess process effectiveness
- Update review guidelines
- Community retrospective

---

## Escalation

If feedback is not addressed in expected timeframe:

1. **Check Status**: Review issue comments and labels
2. **Ask for Update**: Comment on issue requesting status
3. **Discuss**: Use GitHub Discussions for broader questions
4. **Contribute**: Consider contributing a fix or implementation

---

## Continuous Improvement

The feedback review process itself is subject to improvement:

- Regular process reviews
- Community input on process
- Metrics-driven improvements
- Adaptation based on project needs

---

**Last Updated**: 2025-01-24
**Next Review**: 2025-04-24
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
assignees: ''
---

## Description
A clear and concise description of what the bug is.

## Steps to Reproduce
1.
2.
3.

## Expected Behavior
A clear and concise description of what you expected to happen.

## Actual Behavior
A clear and concise description of what actually happened.

## Environment
- **OS**: [e.g., Ubuntu 22.04, macOS 14.0, Windows 11]
- **Python Version**: [e.g., 3.10.5]
- **Package Version**: [e.g., 0.5.2]
- **Installation Method**: [e.g., pip, conda, from source]

## Code Sample
```python
# Minimal code sample that reproduces the issue
```

## Error Messages
```
Paste any error messages or tracebacks here
```

## Additional Context
Add any other context about the problem here.

## Checklist
- [ ] I have searched existing issues to ensure this bug hasn't been reported
- [ ] I have provided all relevant environment information
- [ ] I have included a minimal code sample that reproduces the issue
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: GitHub Discussions
url: https://github.com/SvrusIO/fAIr/discussions
about: Ask questions, share ideas, and discuss with the community
- name: Documentation
url: https://github.com/SvrusIO/fAIr/blob/main/README.md
about: Check the documentation for usage examples and guides
- name: Security Issues
url: https://github.com/SvrusIO/fAIr/security
about: Report security vulnerabilities privately
Loading
Loading