Skip to content
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.

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

Updating contribution docs #8212

Merged
merged 2 commits into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Next Next commit
Updating contribution docs
Signed-off-by: Karishma Chawla <kachawla@microsoft.com>
  • Loading branch information
kachawla committed Jan 9, 2025
commit 3f51776bc53740017877c0ac8a1063e610e6367c
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ On our supported OSes using a package manager to install these dependencies is a

## Required installs

We recommend the usage of either GitHub Codespaces or dev containers to setup your development environment. Here are the links that provide more details:
We recommend the usage of either dev containers to setup your development environment. Here are the links that provide more details:
kachawla marked this conversation as resolved.
Show resolved Hide resolved

- [Getting started - GitHub Codespaces](../contributing-code-prerequisites/README.md#github-codespaces)
<!-- - [Getting started - GitHub Codespaces](../contributing-code-prerequisites/README.md#github-codespaces) -->
- [Getting started - Dev Containers](../contributing-code-prerequisites/README.md#vs-code-and-dev-container)

However, you can also install all tools locally. This is the list of core dependencies to install for the most common tasks. In general we expect all contributors to have all of these tools present:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Alternatively, you can choose whichever editor you are most comfortable for work
- [Visual Studio Code](https://code.visualstudio.com/)
- [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go)

> 📝 **Tip** - If your are using GitHub Codespaces or Dev Containers, the Go extension is already installed for you. You find more details on these options in the [Repository Prerequisites](../contributing-code-prerequisites/README.md).
> 📝 **Tip** - If your are using Dev Containers, the Go extension is already installed for you. You find more details on these options in the [Repository Prerequisites](../contributing-code-prerequisites/README.md).

Install both of these and then follow the steps in the *Quick Start* for the Go extension.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

This page lists the prerequisites for working with the repository. In general, you have three options to get your development setup up and running:

- Remotely using GitHub Codespaces
<!-- - Remotely using GitHub Codespaces -->
- Using Visual Studio Code and dev containers
- Locally by installing all prerequisites on your machine

We will walk you through the options in the following sections.

> 📝 **Tip** - We recommend the usage of GitHub Codespaces or dev containers in Visual Studio Code as they are the most convenient way to get started.
> 📝 **Tip** - We recommend the usage of dev containers in Visual Studio Code as they are the most convenient way to get started.

Depending on the task you need to perform, you may need to install more tools, but basic prerequisites should be sufficient for most contributors to get started.

Expand All @@ -22,9 +22,9 @@ If you get stuck with any development setup option, please ask for help in our [

## Development environment - setup options

The following sections describe the aforementioned alternatives of development setups in more detail. We recommend to use of _GitHub Codespaces_ or _dev containers_ in VS Code as they are the most convenient way to get started.
The following sections describe the aforementioned alternatives of development setups in more detail. We recommend to use of _dev containers_ in VS Code as they are the most convenient way to get started.
kachawla marked this conversation as resolved.
Show resolved Hide resolved

### GitHub Codespaces
<!-- ### GitHub Codespaces

The easiest way to get started is using our pre-built GitHub Codespace.

Expand All @@ -36,7 +36,7 @@ The steps to execute are:

1. There is no second step - you are ready to contribute 😎

> **Note** - When using GitHub Codespaces cost can occur on your side after you have used up the monthly included storage and core hours for your account. You find more details [here](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces).
> **Note** - When using GitHub Codespaces cost can occur on your side after you have used up the monthly included storage and core hours for your account. You find more details [here](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces). -->

### VS Code and Dev Container

Expand Down Expand Up @@ -72,7 +72,7 @@ Once the container is up and running you can start with your contribution.

Contributing to Radius requires several tools to get started. This section lists them grouped by their context

> 📝 **Tip** - If your are using [GitHub Codespaces](#github-codespaces) or [VS Code and Dev Container](#vs-code-and-dev-container), all these tools are already in place and available out-of-the-box.
> 📝 **Tip** - If your are using [VS Code and Dev Container](#vs-code-and-dev-container), all these tools are already in place and available out-of-the-box.

<!--
Note: some of this content is synchronized with the first-commit guide for simplicity. Keep these in sync!
Expand Down
5 changes: 2 additions & 3 deletions docs/contributing/how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

We welcome and encourage users to contribute to the Radius open-source project in various ways. By joining our community, you can make a meaningful impact and help shape the future of this project. Here are some ways you can get involved:

* Learn how: Browse our guides for how to [install repository prerequisites](./contributing-code/contributing-code-prerequisites/), [build the code](./contributing-code/contributing-code-building/), [understand the code](./contributing-code/contributing-code-organization/), [write code for the project](./contributing-code/contributing-code-writing/), and [run tests](./contributing-code/contributing-code-tests/). This is essential knowledge for working with the repository.
* Learn how: Browse our guides for how to [install repository prerequisites](./contributing-code/contributing-code-prerequisites/), [build the code](./contributing-code/contributing-code-building/), [understand the code](./contributing-code/contributing-code-organization/), [write code for the project](./contributing-code/contributing-code-writing/), [run control plane locally](./contributing-code/contributing-code-control-plane/running-controlplane-locally.md), and [run tests](./contributing-code/contributing-code-tests/). This is essential knowledge for working with the repository.

* Tackle small tasks: Start by addressing small issues or tasks labeled as ["good first issues"](https://github.com/radius-project/radius/issues?q=is:issue+is:open+label:%22good+first+issue%22) This allows you to familiarize yourself with the project and make valuable contributions without a steep learning curve.

Expand All @@ -12,8 +12,7 @@ We welcome and encourage users to contribute to the Radius open-source project i

* Submit pull requests: Once you've made changes or improvements to your forked repository, [submit a pull request](./contributing-pull-requests/) to the main project. Provide clear descriptions of the purpose and benefits of your changes.

* Help with code reviews: Give feedback and help with changes made by others
* through [code reviews](./contributing-code/contributing-code-reviewing/).
* Help with code reviews: Give feedback and help with changes made by others through [code reviews](./contributing-code/contributing-code-reviewing/).

* Engage with the community: Participate in discussions, forums, and chat channels related to Radius. Seek guidance, offer help to others, and build connections within the community.

Expand Down