Skip to content

📝 Contributing

Overview

We welcome contributions to this documentation platform from archaeologists, researchers, developers, and anyone interested in advancing archaeological research and technology. This guide will help you understand how to contribute effectively. Please make sure you are comfortable with the fundamentals discussed before contributing.

How to Contribute

Reporting Issues

  • Use clear, descriptive titles
  • Provide detailed information
  • Include steps to reproduce
  • Add relevant screenshots

Suggesting Enhancements

  • Describe the proposed change
  • Explain the benefits
  • Provide implementation details
  • Include examples if possible

Contribution Guidelines

Documentation Contributions

  • Use clear, concise language
  • Follow the style guide
  • Include examples
  • Add relevant links

Style Guide

Writing Style

  • Use clear, professional language
  • Be concise and specific
  • Include examples
  • Use proper formatting

Getting Started

Prerequisites

  • Git
  • code editor (visual studio)
  • Basic understanding of markdown
  • Technical writing skills

Best Practices

  • Keep it up to date
  • Be thorough
  • Include examples
  • Add references
  • Review carefully

Questions?

If you have any questions about contributing:

  • Check the documentation
  • Join the community
  • Contact the maintainers

Return to Home