Contributing

Contributing

Thank you for your interest in contributing to Aletheia!

---

Ways to Contribute

Report Bugs

Found a bug? Please open an issue with:

• Clear description of the problem
• Steps to reproduce
• Expected vs actual behavior
• Browser and extension version

Suggest Features

Have an idea? Start a discussion or open an issue with the enhancement label.

Submit Code

Want to fix a bug or add a feature? See the Developer Guide for setup instructions.

Improve Documentation

Documentation improvements are always welcome. This wiki, code comments, and README all benefit from community input.

---

Code Contribution Process

1. Find an Issue

• Check open issues
• Look for good first issue or help wanted labels
• Comment on the issue to claim it

2. Fork and Clone

git clone https://github.com/YOUR-USERNAME/Aletheia.git
cd Aletheia

3. Create a Branch

git checkout -b issue-number-short-description

4. Make Changes

• Follow existing code style
• Add tests for new functionality
• Update documentation as needed

5. Test Your Changes

poetry run pytest
npm run lint
poetry run ruff check .

6. Commit

Use conventional commit format:

type: description (ref #issue-number)

Types: feat, fix, docs, test, chore, refactor

7. Push and Create PR

git push origin your-branch-name

Then open a Pull Request on GitHub.

---

Code Standards

Python

• Follow PEP 8 style
• Use type hints
• Pass Ruff and Mypy checks
• Maintain test coverage

JavaScript

• Pass ESLint checks
• No TypeScript (vanilla JS for simplicity)
• Comment complex logic

Documentation

• Update docs for user-facing changes
• Write clear commit messages
• Include PR descriptions

---

Pull Request Guidelines

Before Submitting

• Tests pass locally
• Linting passes
• Documentation updated (if applicable)
• Commit messages follow convention

PR Description

Include:

• What the PR does
• Why it's needed
• How to test it
• Related issue(s)

Review Process

1. Maintainer reviews code
2. CI checks must pass
3. Address feedback
4. Merge when approved

---

Security Issues

Do not open public issues for security vulnerabilities.

Use Private Vulnerability Reporting instead.

---

Code of Conduct

Be respectful and constructive. We're building something to help people understand language better — let's communicate well ourselves.

---

Questions?

• Check the FAQ
• Open a discussion
• Review the Developer Guide

---

Last updated: 2026-01-04 18:04 CT