# CONTRIBUTING GUIDE

## Introduction
Welcome to the `multitonic` repository! This guide is designed to provide a streamlined process for contributing to our project. We value your input and are excited to collaborate with you.

## Prerequisites
Before contributing, make sure you have a GitHub account. You should also join our Tonic-AI Discord to communicate with other contributors and the core team.

## How to Contribute

### Reporting Issues
- **Create an Issue**: If you find a bug or have a feature request, please create an issue to report it. Use clear and descriptive titles and provide as much information as possible.
- **Use the Issue Template**: Follow the issue template provided to ensure all relevant information is included.
- **Discuss in Discord**: For immediate feedback or discussion, bring up your issue in the `#multitonic-discussion` channel on Discord.

### Making Changes
- **Fork the Repository**: Start by forking the repository to your own GitHub account.
- **Create a Branch**: Create a branch in your forked repository for your proposed changes. Name the branch something relevant to the changes you're making (e.g., `feature-add-login` or `bugfix-header-alignment`).
```bash
git checkout -b your-branch-name
```  
- **Make Your Changes**: Perform the necessary changes to the codebase or documentation.
- **Commit Your Changes**: Use meaningful commit messages that describe what you've done.

```bash
git commit -m "Your detailed commit message"
```

- **Push to Your Fork**: Push your changes to your forked repository on GitHub.

```bash
git push origin your-branch-name
```

### Submitting a Pull Request
- **Pull Request (PR)**: Go to the original `multitonic` repository and click on "Pull Request" to start the process.
- **PR Template**: Fill in the PR template with all the necessary details, linking the issue you're addressing.
- **Code Review**: Wait for the core team or community to review your PR. Be responsive to feedback.
- **Merge**: Once your PR has been approved and passes all checks, it will be merged into the main codebase.

## Code of Conduct
Please adhere to the Code of Conduct laid out in the `CODE_OF_CONDUCT.md` [file](src/documentation/CODE_OF_CONDUCT.md) file. Respectful collaboration is key to a healthy open-source environment.

## Questions or Additional Help
If you need further assistance or have any questions, please don't hesitate to ask in our Discord community or directly in GitHub issues.

Thank you for contributing to `multitonic`!