> ## Documentation Index
> Fetch the complete documentation index at: https://tonic-ai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Contributing to CreditNexus

> Guidelines for contributing to the CreditNexus project

Thank you for your interest in contributing to CreditNexus! We welcome contributions from the community.

## How to Contribute

### 1. Fork the Repository

Fork the [CreditNexus repository](https://github.com/josephrp/creditnexus) on GitHub.

### 2. Create a Branch

Create a feature branch from `main`:

```bash theme={null}
git checkout -b feature/your-feature-name
```

### 3. Make Changes

* Follow the code style and patterns established in the codebase
* Write clear commit messages
* Add tests for new features
* Update documentation as needed

### 4. Submit a Pull Request

* Push your changes to your fork
* Open a pull request against the `main` branch
* Provide a clear description of your changes
* Reference any related issues

## Code Style

### Python

* Follow PEP 8 style guide
* Use type hints
* Use `ruff` for linting
* Use `black` for formatting

### TypeScript/React

* Use TypeScript (no `any` types)
* Follow React best practices
* Use functional components with hooks
* Use Tailwind CSS for styling

## Testing

* Write unit tests for new features
* Ensure all tests pass
* Add integration tests for API endpoints
* Test with multiple LLM providers when applicable

## Documentation

* Update relevant documentation files
* Add code comments for complex logic
* Update API documentation for new endpoints
* Follow existing documentation patterns

## Code of Conduct

* Be respectful and inclusive
* Provide constructive feedback
* Follow professional communication standards

## Additional Resources

* [GitHub Repository](https://github.com/josephrp/creditnexus)
* [License Information](../legal/license.mdx)
* [Architecture Documentation](https://tonic-ai.mintlify.app/architecture/overview)

***

**Last Updated**: 2026-01-14