Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (25 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 2.45 KB
Raw

Contributing to tin+topo Projects

Thank you for your interest in contributing to colinstiles' open-source projects! Your help is appreciated. Contributions should make repositories clearer, more reliable, and easier to use.

By participating, you are expected to uphold our Code of Conduct.

How Can I Contribute?

🐛 Reporting Bugs or Errors

If you find a bug, a typo, or an error in the data or documentation, please open a bug report issue. Before submitting, check existing issues to see if someone has already reported it.

✨ Suggesting Enhancements

Have an idea for a new feature, a better map, or an improved workflow? We'd love to hear it. Please open a feature request issue to start a discussion.

🔃 Submitting Pull Requests

If you want to contribute code, documentation, or other changes directly, please follow these steps:

  1. Open an Issue: For anything but the most minor fixes (like a typo), please open an issue first to discuss the proposed change. This saves everyone time by making sure we're aligned on the approach.

  2. Fork & Branch: Fork the repository to your own account and create a new branch for your work.

  3. Make Your Changes: Make your changes, keeping them focused on the issue you are addressing. Avoid committing credentials, private records, or sensitive operational data.

  4. Open a Pull Request: When you're ready, open a pull request from your branch to the main branch of the TDA repository. In the pull request description, please include:

    • A clear summary of what changed.
    • A reference to the issue it resolves (e.g., Fixes #123).
    • Any tests, checks, screenshots, maps, or sample outputs that help with review.

Guidelines for GIS and Data Changes

For changes involving data, scripts, maps, or spatial workflows, please document the following in your pull request or issue:

  • Source Data: Where did the data come from and what is its vintage/update date?
  • Projections: Note the coordinate reference system (CRS) if it's relevant to the change.
  • Processing Steps: Briefly describe any transformations that affect analysis results.
  • Limitations: Note any known quality concerns or manual steps involved.

Review Process

A repository maintainer will review your contribution. They may ask for changes to improve clarity, reproducibility, security, or long-term maintainability. We appreciate your patience and collaboration during this process.