From 554fda1a9f9bb555bb873354a91912fb8a0862c6 Mon Sep 17 00:00:00 2001 From: bshifaw Date: Wed, 6 Dec 2023 11:42:33 -0500 Subject: [PATCH] Added section on external contribution to development Readme (#435) * Added section on external contribution * Added links to repo site to main repo README.md --------- Co-authored-by: bshifaw --- README.md | 4 ++++ docs/development_guide/README.md | 23 +++++++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/README.md b/README.md index 70fa1efc3..d7c62a9d3 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,7 @@ This repository contains pipelines for processing of long read data from PacBio and/or Oxford Nanopore platforms. The pipelines are written in [WDL 1.0](https://github.com/openwdl/wdl/blob/main/versions/1.0/SPEC.md#introduction) intended for use with Google Cloud Platform via the scientific workflow engine, [Cromwell](https://github.com/broadinstitute/cromwell). Processing is designed to be reasonably consistent between both long read platforms, and use platform-specific options or tasks where necessary. High level workflows can be found in the wdl/ directory. + +**Documentation**: Documentation for each workflow can be found at the repository [site](https://broadinstitute.github.io/long-read-pipelines/). + +**External Contributors**: Please see the [Contributing Guidelines](https://broadinstitute.github.io/long-read-pipelines/development_guide/#contributing-guidelines) for information on how to contribute to the repository. diff --git a/docs/development_guide/README.md b/docs/development_guide/README.md index 1075241ed..9110dd8e4 100644 --- a/docs/development_guide/README.md +++ b/docs/development_guide/README.md @@ -67,3 +67,26 @@ Please adhere to the following best practices if contributing to this repository 6. **Submit a pull request**: Once you have made your changes and tested them, submit a pull request to the main repository. Make sure to include a clear description of the changes you made and why you made them. This makes it easier for others to review and merge your changes into the main repository. 7. **Add reviewers**: Once you have submitted your pull request, add reviewers to the pull request. This will notify them that you have submitted a pull request and they should review it. It's important to add at least one reviewer to your pull request. 8. **Merging pull requests**: Once your pull request has been reviewed and approved, it can be merged into the main repository. It's important to merge pull requests using the "Squash and merge" option. This will squash all commits in the pull request into a single commit, which makes it easier to track changes in the repository. + +### External Contributions + +External contributions are welcome. Please follow the guidelines and submit a pull request. + +#### Review Criteria + +To maintain quality and consistency, contributions are reviewed based on: + +- **Adherence to coding standards**: The code should follow the project's coding standards, such as naming conventions, indentation, and code style. +- **Passing tests**: All existing tests should pass after the changes are applied. New tests should be added to cover the new functionality. +- **Documentation updates**: If the contribution introduces new features or changes existing workflows, the documentation should be updated accordingly. +- **Overall quality**: The contribution should be of overall high quality, with well-structured code, clear comments, and a minimal impact on other parts of the codebase. + +#### Review Process + +The review process is designed to ensure that contributions are of high quality and consistent with the rest of the codebase. The review process consists of the following steps: +1. **Code Review**: Reviewers provide feedback for improvements or issue identification. +2. **Testing**: Ensure code functions as intended without introducing bugs. +3. **Merging**: Approved code becomes part of the main repository. +4. **Release**: Automatic generation of releases upon merging to the main branch. + +