CONTRIBUTING.md

Contributing to RealEstateAPI Documentation

We welcome contributions to improve our documentation! This guide will help you get started.

How to Contribute

Reporting Issues

If you find any issues with our documentation:

1. Check if the issue already exists in our GitHub Issues
2. If not, create a new issue with:
   • Clear description of the problem
   • Steps to reproduce (if applicable)
   • Expected vs actual behavior
   • Any relevant code snippets

Suggesting Improvements

We appreciate suggestions for:

• Missing documentation
• Unclear explanations
• Additional code examples
• New integration guides
• Typos and grammatical errors

Submitting Changes

1. Fork the Repository

   git clone https://github.com/realestateapi/docs.git
   cd docs

2. Create a Branch

   git checkout -b feature/your-improvement

3. Make Your Changes

   • Follow the existing documentation style
   • Test any code examples
   • Update relevant sections

4. Commit Your Changes

   git add .
   git commit -m "docs: clear description of your changes"

5. Submit a Pull Request

   • Push to your fork
   • Create a pull request with a clear description
   • Link any related issues

Documentation Standards

Writing Style

• Use clear, concise language
• Write in present tense
• Use active voice
• Avoid jargon without explanation
• Include examples for complex concepts

Code Examples

• Test all code examples
• Use consistent formatting
• Include language-specific comments
• Show both request and response
• Handle errors appropriately

Formatting

• Use Markdown for all documentation
• Follow CommonMark specification
• Use appropriate headers (H1 for titles, H2 for main sections)
• Include table of contents for long documents

Code Example Template

When adding code examples, follow this structure:

### Example: [Description]

**Request:**
```[language]
// Add helpful comments
// Show the actual code

Response:

{
  // Show expected response
}

Error Handling:

// Show how to handle errors

## Review Process

1. All contributions are reviewed by our team
2. We may request changes or clarifications
3. Once approved, changes will be merged
4. Documentation is automatically deployed

## Questions?

If you have questions about contributing:
- Email: docs@realestateapi.com
- Open a discussion in GitHub Discussions

Thank you for helping improve RealEstateAPI documentation!