Skip to content

Commit

Permalink
Fix CONTRIBUTING.md to refer to Workflow Manager
Browse files Browse the repository at this point in the history
- Update Dockerfile to use .NET6  images

Signed-off-by: Victor Chang <vicchang@nvidia.com>
  • Loading branch information
mocsharp committed Mar 29, 2022
1 parent c5d578f commit 73390f3
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
# Created by https://www.toptal.com/developers/gitignore/api/aspnetcore,dotnetcore,visualstudio,visualstudiocode
# Edit at https://www.toptal.com/developers/gitignore?templates=aspnetcore,dotnetcore,visualstudio,visualstudiocode

# CLI
cli/

# Database
*.db

Expand Down
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ SPDX-FileCopyrightText: � 2021-2022 MONAI Consortium

## Introduction

Welcome to Project MONAI Deploy Informatics Gateway! We're excited you're here and want to contribute. This documentation is intended for individuals and institutions interested in contributing to the MONAI Deploy Informatics Gateway. MONAI Deploy Informatics Gateway is an open-source project. As such, its success relies on its community of contributors willing to keep improving it. Therefore, your contribution will be a valued addition to the code base; we ask that you read this page and understand our contribution process, whether you are a seasoned open-source contributor or a first-time contributor.
Welcome to Project MONAI Deploy Workflow Manager! We're excited you're here and want to contribute. This documentation is intended for individuals and institutions interested in contributing to the MONAI Deploy Workflow Manager. MONAI Deploy Workflow Manager is an open-source project. As such, its success relies on its community of contributors willing to keep improving it. Therefore, your contribution will be a valued addition to the code base; we ask that you read this page and understand our contribution process, whether you are a seasoned open-source contributor or a first-time contributor.

### Communicate with us

We are happy to talk with you about your MONAI Deploy Informatics Gateway needs and your ideas for contributing to the project. One way to do this is to create an [issue](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/issues/new/choose) by discussing your thoughts. It might be that a very similar feature is under development or already exists, so an issue is a great starting point. If you are looking for an issue to resolve that will help Project MONAI Deploy Informatics Gateway, see the [*good first issue*](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/labels/good%20first%20issue) and [*help wanted*](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/labels/help%20wanted) labels.
We are happy to talk with you about your MONAI Deploy Workflow Manager needs and your ideas for contributing to the project. One way to do this is to create an [issue](https://github.com/Project-MONAI/monai-deploy-workflow-manager/issues/new/choose) by discussing your thoughts. It might be that a very similar feature is under development or already exists, so an issue is a great starting point. If you are looking for an issue to resolve that will help Project MONAI Deploy Workflow Manager, see the [*good first issue*](https://github.com/Project-MONAI/monai-deploy-workflow-manager/labels/good%20first%20issue) and [*help wanted*](https://github.com/Project-MONAI/monai-deploy-workflow-manager/labels/help%20wanted) labels.

## The contribution process

Expand Down Expand Up @@ -84,18 +84,18 @@ All source code files should start with this paragraph:
#### Test Projects

All C# projects reside in their directory, including a `Tests/` subdirectory.
Test projects are also linked in the main solution file [Monai.Deploy.InformaticsGateway.sln](src/Monai.Deploy.InformaticsGateway.sln) and can be executed either using Visual Studio's *Test Explorer* or with the `dotnet test` command line.
Test projects are also linked in the main solution file [Monai.Deploy.WorkloadManager.sln](src/Monai.Deploy.WorkloadManager.sln) and can be executed either using Visual Studio's *Test Explorer* or with the `dotnet test` command line.


_If it's not tested, it's broken_

An appropriate set of tests should accompany all new functionality.
MONAI Deploy Informatics Gateway functionality has plenty of unit tests from which you can draw inspiration, and you can reach out to us if you are unsure how to proceed with testing.
MONAI Deploy Workflow Manager functionality has plenty of unit tests from which you can draw inspiration, and you can reach out to us if you are unsure how to proceed with testing.


#### Building the documentation

Documentation for MONAI Deploy Informatics Gateway is located at `docs/` and requires [DocFX](https://dotnet.github.io/docfx/) to build.
Documentation for MONAI Deploy Workflow Manager is located at `docs/` and requires [DocFX](https://dotnet.github.io/docfx/) to build.

Please follow the [instructions](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool) to install Mono and download the DocFX command-line tool to build the documentation.

Expand Down Expand Up @@ -204,10 +204,10 @@ For example, branch name `{username}/19-ci-pipeline-setup` corresponds to issue

### Release a new version

A PR is made from a `release/` branch to the `main` branch when a new official release is ready. The CI process validates & builds all components required, composes the release notes, and publishes the build in the [Releases](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/releases) section and any Docker images in the [Packages](https://github.com/orgs/Project-MONAI/packages?repo_name=monai-deploy-informatics-gateway) section.
A PR is made from a `release/` branch to the `main` branch when a new official release is ready. The CI process validates & builds all components required, composes the release notes, and publishes the build in the [Releases](https://github.com/Project-MONAI/monai-deploy-workflow-manager/releases) section and any Docker images in the [Packages](https://github.com/orgs/Project-MONAI/packages?repo_name=monai-deploy-workflow-manager) section.

- [Actions](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/actions)
- [Issues](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/issues)
- [Milestones](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestones)
- [Releases](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/releases)
- [Packages](https://github.com/orgs/Project-MONAI/packages?repo_name=monai-deploy-informatics-gateway)
- [Actions](https://github.com/Project-MONAI/monai-deploy-workflow-manager/actions)
- [Issues](https://github.com/Project-MONAI/monai-deploy-workflow-manager/issues)
- [Milestones](https://github.com/Project-MONAI/monai-deploy-workflow-manager/milestones)
- [Releases](https://github.com/Project-MONAI/monai-deploy-workflow-manager/releases)
- [Packages](https://github.com/orgs/Project-MONAI/packages?repo_name=monai-deploy-workflow-manager)
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

FROM mcr.microsoft.com/dotnet/sdk:5.0-focal as build
FROM mcr.microsoft.com/dotnet/sdk:6.0-focal as build

ARG Version=0.0.0
ARG FileVersion=0.0.0.0
Expand All @@ -26,7 +26,7 @@ RUN echo "Building MONAI Workload Manager $Version ($FileVersion)..."
RUN dotnet publish -c Release -o out --nologo /p:Version=$Version /p:FileVersion=$FileVersion src/WorkloadManager/Monai.Deploy.WorkloadManager.csproj

# Build runtime image
FROM mcr.microsoft.com/dotnet/runtime:5.0-focal
FROM mcr.microsoft.com/dotnet/runtime:6.0-focal

ENV DEBIAN_FRONTEND=noninteractive

Expand Down

0 comments on commit 73390f3

Please sign in to comment.