Skip to content

Contribute.md

Latest commit

 

History

History
102 lines (63 loc) · 2.91 KB

Contribute.md

File metadata and controls

102 lines (63 loc) · 2.91 KB

TheDookArchive Contributing Guide

Welcome

Welcome to the TheDookArchive Contributing Guide, and thank you for your interest!

If you would like to contribute, check out the following list of accepted contributions and their corresponding sections within this guide:

Data Collection Contributions

  • Adding new historical events
  • Verifying and improving existing data
  • Categorizing and tagging collected information

TheDookArchive Overview

The purpose of TheDookArchive is to collect and organize historical events, providing a structured way to analyze past occurrences. The project aims to create an accessible and accurate database of information.

Ground Rules

Before contributing, please ensure you adhere to the project's guidelines and maintain data accuracy and neutrality.

Community Engagement

To connect with fellow contributors or stay updated on project developments:

  • Join our discussions on {Platform Name & Link}
  • Participate in project meetings held {Specify Day & Time} via {Meeting Link}
  • Follow the latest updates through our {Newsletter Signup Link}

Share Ideas

To propose new ideas for the project:

  1. Open an issue in the repository.
  2. Describe your idea and its potential impact.
  3. Discuss with the community and refine the concept.

Before You Start

Ensure you have the following before contributing:

  • A GitHub account
  • Basic knowledge of markdown formatting
  • Willingness to collaborate and verify historical accuracy

Best Practices

To maintain consistency and quality in contributions:

  • Use reliable sources for historical data.
  • Follow structured formatting for event entries.
  • Verify information before submitting.

Contribution Workflow

Fork and Clone Repository

  1. Fork this repository to your own GitHub account.

  2. Clone it locally using:

    git clone https://github.com/{your-username}/TheDookArchive.git

Report Issues and Bugs

If you find incorrect data or inconsistencies:

  1. Open a GitHub issue explaining the problem.
  2. Provide references to validate corrections.
  3. Discuss with maintainers before making changes.

Issue Management

  • Tag issues appropriately (e.g., data-verification, new-entry, discussion).
  • Assign yourself an issue before working on it.

Commit Messages

Follow this format for commit messages:

Pull Requests

To submit your contribution:

  1. Push your branch to GitHub:

    git push origin feature/new-historical-event

  2. Open a Pull Request (PR) on the repository.

  3. Describe your contribution in detail and link relevant sources.

  4. Wait for maintainers to review and merge your changes.

Releases

  • Major updates to the database are released monthly.
  • Minor updates and corrections are merged as needed.

Text Formats

  • Use Markdown (.md) for documentation.
  • Follow structured templates for historical entries.