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.

Sign up for GitHub

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

fix: improve intro to contributing #63

Merged
merged 3 commits into from
Mar 18, 2023
Merged

fix: improve intro to contributing #63

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
811f27d
fix: improve intro to contributing
diivi Mar 14, 2023
d574a29
any repository can be forked
diivi Mar 15, 2023
ab694bb
redirect to hot repo
diivi Mar 18, 2023
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
18 changes: 13 additions & 5 deletions docs/contributing/introduction-to-contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,12 @@ Some thoughts to help you contribute to this project

## Setup

TL;DR: forks are preferred.
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the main repository at [open-sauced/insights](https://github.com/open-sauced/insights) to your own GitHub account.
diivi marked this conversation as resolved.
Show resolved Hide resolved
1. Clone the forked repository to your local machine.
1. Run `npm ci` to install the dependencies and set up the project.

You can also use the shell commands below to get started once you have forked the repository.
Make sure to replace `<your-name>` with your GitHub username.

```shell
git clone https://github.com/<your-name>/open-sauced
Expand Down Expand Up @@ -88,11 +93,14 @@ GitHub has support for draft pull requests, which will disable the merge button

## Issues

If you plan to contribute a change based on an open issue, please assign yourself by commenting on the following word `.take`. Issues that are not assigned are assumed open, and to avoid conflicts, please assign yourself before beginning work on any issues.
If you wish to work on an open issue, please comment on the issue with `.take` and it will be assigned to you. If an issue is not assigned, it is assumed to be open for anyone to work on. Please assign yourself to an issue before beginning work on it to avoid conflicts.

If you are contributing to the project for the first time, please consider joining checking the [bug](https://github.com/open-sauced/open-sauced/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%90%9B+bug%22) or [good first issue](https://github.com/open-sauced/open-sauced/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) labels.
diivi marked this conversation as resolved.
Show resolved Hide resolved
diivi marked this conversation as resolved.
Show resolved Hide resolved

In case you get stuck, please feel free to ask for help in the [Discord](https://discord.gg/U2peSNf23P) server or GitHub Discussions.

If you would like to contribute to the project for the first time, please consider joining checking the [bug](https://github.com/open-sauced/open-sauced/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%90%9B+bug%22) or [good first issue](https://github.com/open-sauced/open-sauced/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) labels.
Please note that we have a [code of conduct](./code-of-conduct.md), please follow it in all your interactions with the project and it's contributors.

Also, all questions are welcomed.

## Triage team

Expand All @@ -104,7 +112,7 @@ For those interested in getting involved in the project or just open source in g

## Funding

Open Sauced is a part of GitHub Sponsors. If you would like to contribute, please note the [sponsor page](https://github.com/sponsors/open-sauced) for details on how funds are distributed. If you have made any contributions to the projectd directly or indirectly, please consider adding your profile to the [funding.yml](https://github.com/open-sauced/open-sauced/blob/main/.github/funding.yml).
Open Sauced is a part of GitHub Sponsors. If you would like to contribute, please note the [sponsor page](https://github.com/sponsors/open-sauced) for details on how funds are distributed. If you have made any contributions to the projectd directly or indirectly, please consider adding your profile to the [FUNDING.yml](https://github.com/open-sauced/.github/blob/main/FUNDING.yml).

## Community

Expand Down