Contributing to Awesome LLM Domains

Thank you for your interest in contributing to the Awesome LLM Domains project! This document provides guidelines and instructions for contributing to this repository.

Types of Contributions

We welcome the following types of contributions:

1. Adding new content: Create new documents about LLM-related topics not covered yet

2. Updating existing content: Keep documents up-to-date with the latest developments

3. Improving documentation: Enhance clarity, fix errors, or improve organization

4. Adding references: Include additional papers, projects, or resources

5. Translations: Translate content to make it accessible to non-English speakers

Content Guidelines

When contributing content, please follow these guidelines:

• Educational Focus: Content should be educational and aim to explain concepts clearly

• Accuracy: Information should be accurate and properly sourced

• Neutrality: Present balanced viewpoints and avoid promotional content

• Accessibility: Write in a way that is understandable to a broad audience

• Attribution: Properly cite sources and respect copyright

How to Contribute

Creating or Updating Content

1. Fork the repository: Create your own fork of the project

2. Create a branch: Make a branch for your contribution

3. Make your changes: Add or modify content following our structure and guidelines

4. Test your changes: Ensure all links work and Markdown renders correctly

5. Submit a pull request: Include a clear description of your changes

Content Structure

When adding new documents:

• Place files in the appropriate directory (Foundations, Models, Agents)

• Follow the established Markdown formatting style

• Include an introduction, main content sections, and references

• Link to the new document from the main README.md if appropriate

Review Process

After you submit a pull request:

1. Maintainers will review your contribution

2. They may request changes or clarification

3. Once approved, your contribution will be merged

Code of Conduct

Please be respectful and constructive in all interactions. We aim to create a positive and inclusive environment for all contributors.

Questions?

If you have questions about contributing, please open an issue in the repository, and we'll be happy to help.