From 299a0404d012722033016d95d9c45d4c2fa35e95 Mon Sep 17 00:00:00 2001 From: Christopher Meyer Date: Fri, 27 Feb 2026 15:11:49 -0600 Subject: [PATCH] add contributing.md --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2ceecc5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing to MIDRC BIH + +Thank you for contributing to the MIDRC Interoperability Tools. + +## Code of Conduct +This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. + +## Reporting Bugs +Before creating bug reports, please search existing issues to see if the problem has already been reported. When you are creating a bug report, please include as many details as possible: +- Use a clear and descriptive title. +- Describe the exact steps to reproduce the error. +- Explain which behavior you expected and what happened instead. + +## Suggesting Enhancements +Enhancement suggestions are tracked as GitHub issues. +- Check if there's already a similar suggestion. +- Clearly describe the proposed change and why it would be useful. + +## Pull Requests +Please follow these steps to have your contribution considered: +- Fork the repo and create your branch from `main`. +- If you've added code that should be tested, note that and add tests. +- Ensure the test suite passes locally. +- Reference any relevant issues in your PR description. +- Wait for review. Maintainers will look at your PR as soon as possible. + +## Style Guides +Maintain the existing coding style. Run linter before committing to ensure consistent formatting. diff --git a/README.md b/README.md index 0f861d0..164aca4 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,5 @@ This project is built with Python. Ensure you have Python 3.9 or later installed The MIDRC interoperability tools for discovery metadata aggregation use the Gen3 SDK extensively, which can be found in GitHub at https://github.com/uc-cdis/gen3sdk-python. The Gen3 Software Development Kit (SDK) for Python provides classes and functions for handling common tasks when interacting with a Gen3 commons. It also exposes a Command Line Interface (CLI). Working with APIs can be overwhelming, so the MIDRC API adaptors use the Gen3 Python SDK/CLI to simplify communication with various nodes in the biomedical imaging data mesh. +## Contributing +Check out our [CONTRIBUTING.md](CONTRIBUTING.md) doc to learn how to contribute. \ No newline at end of file