Skip to content

docs: add CI workflow, CONTRIBUTING.md, and project structure guide#2

Open
dolepee wants to merge 1 commit intoPluralisResearch:mainfrom
dolepee:add-ci-and-contributing
Open

docs: add CI workflow, CONTRIBUTING.md, and project structure guide#2
dolepee wants to merge 1 commit intoPluralisResearch:mainfrom
dolepee:add-ci-and-contributing

Conversation

@dolepee
Copy link

@dolepee dolepee commented Feb 7, 2026

Summary

Adds foundational CI infrastructure and contributor documentation to make the project more accessible and maintainable.

Changes

1. GitHub Actions CI workflow (.github/workflows/ci.yml)

  • Runs on push/PR to main
  • Lint job: Catches syntax errors and undefined names via flake8 (hard fail), plus style warnings (non-blocking)
  • Import check job: Validates all Python files have correct syntax using ast.parse

2. CONTRIBUTING.md

  • Prerequisites and setup instructions
  • Project structure overview explaining what each module does
  • Contribution guidelines (issues, PRs, code style)
  • How to run experiments with parameter reference table

Motivation

The project currently has no CI or contributor docs. As an ICML 2025 paper implementation, it's likely to attract community interest. These additions lower the barrier to entry for new contributors and catch basic errors automatically.

@dolepee
Copy link
Author

dolepee commented Feb 14, 2026

Hi team, could you please share feedback on this PR when you have a chance? I can apply changes quickly. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant