Skip to content

add contributing.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cgmeyer merged 1 commit into from
Feb 27, 2026
Merged

add contributing.md #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.