From 9f4120b831cdd9752979f0358b2826c13b2b3284 Mon Sep 17 00:00:00 2001 From: dvm-shlee Date: Mon, 29 Apr 2024 21:19:27 -0400 Subject: [PATCH] Update CONTRIBUTING.md and Makefile --- CONTRIBUTING.md | 46 +++++++++++++++++++++++++++++++++------------- Makefile | 2 +- 2 files changed, 34 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fa4da1..60452e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,37 @@ -# Contributing +# Contributing to BrkRaw -When contributing to this repository, please first discuss the change you wish to make via issue, -email, or any other method with the owners of this repository before making a change. +Thank you for your interest in contributing to BrkRaw! Whether you're tackling a bug, adding a new feature, or improving our documentation, every contribution is appreciated. This guide will help you get started with your contributions in the most effective way. -Please note we have a code of conduct, please follow it in all your interactions with the project. +## Ways to Contribute -## Pull Request Process +### Reporting Issues -1. Ensure any install or build dependencies are removed before the end of the layer when doing a - build. -2. Update the README.md with details of changes to the interface, this includes new environment - variables, exposed ports, useful file locations and container parameters. -3. Increase the version numbers in any examples files and the README.md to the new version that this - Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). -4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you - do not have permission to do that, you may request the second reviewer to merge it for you. \ No newline at end of file +If you encounter a bug, have a suggestion, or want to make a feature request, please use the Issues section. Include as much detail as possible and label your issue appropriately. + +### Pull Requests + +We welcome pull requests with open arms! Here’s how you can make one: + +- **Code Changes**: If you are updating the BrkRaw codebase, perhaps due to a ParaVision compatibility issue or to suggest a new standard, please make sure your changes are well-documented. +- **New Features**: If you're introducing a new feature, ensure that you include appropriate test scripts in the `tests` directory, following our standard testing workflow. Check our documentation for more details. +- **New Applications**: Contributions that significantly enhance community utility but cannot be integrated via the plugin architecture should be directed to the main BrkRaw package. + +Before creating a pull request, ensure that your code complies with the existing code style and that you have tested your changes locally. + +### Contributing to Child Repositories + +- **[plugin](../brkraw-plugin)**: For new functionalities at the app level, direct your contributions here. +- **[dataset](../brkraw-dataset)**: To add a new dataset that needs to be tested via BrkRaw CI for data conversion consistency and reliability, please contribute here. +- **[tutorial](../brkraw-tutorial)**: For new tutorials, tutorial revisions, or documentation that would help other users, please contribute to this repository. + +## Before You Start + +Please review the documentation and Q&A to see if your question has already been answered or if the feature has already been discussed. If you’re unsure about adding a feature or making a change, open an issue to discuss it first. + +## Contribution Guidelines + +- Ensure your contributions are clear and easy to understand. +- Include any necessary tests and documentation updates. +- Adhere to the coding standards and best practices as outlined in our project documentation. + +We look forward to your contributions and are excited to see what you come up with! \ No newline at end of file diff --git a/Makefile b/Makefile index 30cb7df..3a2516a 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ clean: rm -rf tests/tutorials tests/tutorials: - git clone https://github.com/BrkRaw/tutorials.git tests/tutorials + git clone https://github.com/BrkRaw/brkraw-tutorial.git tests/tutorials tests/tutorials/SampleData/20190724_114946_BRKRAW_1_1: tests/tutorials unzip -uq tests/tutorials/SampleData/20190724_114946_BRKRAW_1_1.zip -d tests/tutorials/SampleData/