Skip to content
Merged

Dev #32

Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 47 additions & 0 deletions CONTRIBUTOR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributor's Guide

Thank you for considering contributing to this project. This document outlines the process and guidelines for contributing.

## Table of Contents
- [Getting Started](#getting-started)
- [Pull Requests](#pull-requests)
- [Code Style](#code-style)
- [Reporting Issues](#reporting-issues)
- [Community and Support](#community-and-support)

## Getting Started

1. Fork the repository on GitHub.
2. Clone the forked repository to your local machine.
3. Navigate to the project directory and install the required dependencies.
4. Create a new branch for your feature, bugfix, or improvement.

## Pull Requests

1. Make sure all tests pass and there are no linting errors in your code.
2. Commit your changes in a meaningful manner.
3. Push your branch to your fork.
4. Open a pull request from your branch to the project's `master` or `main` branch.
5. Describe the changes you've made in detail and reference any issues it addresses.

**Note:** Before submitting a pull request, ensure that your changes merge cleanly with the `master` or `main` branch.

## Code Style

- Follow the style of the existing code.
- Include comments to explain the purpose and reasoning behind significant pieces of code.
- Write descriptive commit messages.

## Reporting Issues

- Use the issue tracker to report bugs or suggest features.
- Before submitting a new issue, please search to see if someone has already reported the same issue.
- Include as much information as possible in your report: steps to reproduce the bug, error messages, your operating system/version, etc.

## Community and Support

If you have any questions, join our [discussions](https://github.com/orgs/HIP-infrastructure/discussions).

---

Thank you again for considering contributing to our project!
4 changes: 2 additions & 2 deletions src/components/Documentation/About.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const spaces: Doc[] = [
{
label: 'Onboarding Guide',
buttonLabel: 'guide',
url: 'https://hip-infrastructure.github.io/build/html/hip_onboarding.html',
url: 'https://hip-infrastructure.github.io/user_doc.html',
description:
'See the onboarding guide for a quick overview of the platform.',
image: 'public/media/discover_onboarding.png',
Expand Down Expand Up @@ -59,7 +59,7 @@ const docs = [
{
label: 'HIP User Documentation',
buttonLabel: 'User Documentation',
url: `https://hip-infrastructure.github.io/`,
url: `https://hip-infrastructure.github.io/user_doc.html`,
description: 'HIP guides, tutorials, datasets, Troubleshooting and FAQ',
image: 'public/media/documentation_user.png',
credit:
Expand Down
6 changes: 3 additions & 3 deletions src/components/Documentation/GettingStarted.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ const GettingStarted = (): JSX.Element => {
}
video='getting-started-upload.mp4'
link={
'https://hip-infrastructure.github.io/build/html/guides/GUIDE_How_to_prepare_and_upload_data_to_the_HIP.html'
'https://hip-infrastructure.github.io/guides/GUIDE_How_to_prepare_and_upload_data_to_the_HIP.html'
}
/>
<GettingStartedCard
Expand All @@ -153,7 +153,7 @@ const GettingStarted = (): JSX.Element => {
subtitle='Use a Desktop App to process your data.'
description={'Use Desktops and run applications'}
img='gettingstarted-2.png'
link='https://hip-infrastructure.github.io/build/html/guides/GUIDE_How_to_use_Desktops_and_run_applications_from_the_App_Catalog.html'
link='https://hip-infrastructure.github.io/guides/GUIDE_How_to_use_Desktops_and_run_applications_from_the_App_Catalog.html'
/>
<GettingStartedCard
step={3}
Expand All @@ -169,7 +169,7 @@ const GettingStarted = (): JSX.Element => {
</Box>
}
img='gettingstarted-3.png'
link='https://hip-infrastructure.github.io/build/html/guides/GUIDE_How_to_use_the_HIP_spaces_and_share_data_with_other_users.html'
link='https://hip-infrastructure.github.io/guides/GUIDE_How_to_use_the_HIP_spaces_and_share_data_with_other_users.html'
/>
</Box>
</Box>
Expand Down