sonar/.github/CONTRIBUTING.md

Before you start contributing, please take a moment to review our contributing guidelines. If you can't contribute but like the project, feel free to show your support by starring the project on GitHub or joining the Discord.

Contributing Guidelines:

1. Fork the repository and create a new branch for your contribution.
2. Adhere to the Coding Guidelines and LLM Guidelines.
3. Test your code before committing and pushing it.
4. Use semantic commit messages for your commits.

Coding Guidelines:

• Use the same code style and formatting as the rest of the project.
  • Optional: Use an IDE that supports .editorconfig files.
• Use meaningful names for variables, classes, and methods.
• Write clear comments to explain complex parts of your code.
• Ensure your code is easy to read and maintain.

LLM Guidelines

Keep the use of AI (including LLMs) for code generation to an absolute minimum. If possible, avoid using AI entirely due to potential complications regarding authorship, intellectual property, and copyright.

If AI was utilized during the development of a Pull Request, you must disclose its exact use in the PR description. This includes:

• The specific tool and model used (e.g., GPT 5.4, Claude 4.7 Sonnet, Gemini 3.1 Pro)
• The nature of its use (e.g., optimization)
• The exact prompts used, where relevant

Please note that submissions will be rejected if AI usage raises concerns regarding code quality, licensing, or integrity.

Bug Reports:

1. Check if someone has already reported the bug.
2. If not, open a new issue with a clear and detailed title.
3. Describe the bug, including the steps to reproduce it.
4. Include all logs related to the issue.
5. Provide the output of '/sonar dump'.
6. Feel free to provide any additional information.

Feature Requests:

1. Check if someone has already made the same request.
2. If not, open a new issue with a clear and detailed title.
3. Explain the feature you want to see in Sonar and provide an example.
4. Explain why you want to see the feature in Sonar.
5. Feel free to provide any additional information.

Pull Requests:

• Use a clear and descriptive title for your pull request.
• Provide a detailed description of the changes you made.
• Reference related issues or pull requests.
• Make sure everything is properly tested.