Skip to content

Commit

Permalink
fix: Issues Section (open-sauced#269)
Browse files Browse the repository at this point in the history
* Fix issues section by capitalizing COC and adding alert boxes for tips and notes

* Change copy based on PR feedback

* Update introduction-to-contributing.md

Deleted last sentence because redundant. Thank you for pointing this out!

* Deleted last sentence
  • Loading branch information
smhussain5 authored Mar 4, 2024
1 parent ccd6258 commit 785e75a
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions docs/contributing/introduction-to-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ keywords:
---

Contributions are always welcome, no matter how large or small. Before contributing,
please read the [code of conduct](./code-of-conduct.md) and follow the directions below:
please read the [Code of Conduct](./code-of-conduct.md) and follow the directions below:

## Recommended Communication Style

Expand All @@ -28,13 +28,26 @@ please read the [code of conduct](./code-of-conduct.md) and follow the direction

## 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 available for anyone to work on. Please assign yourself to an issue before working on it to avoid conflicts.
- If you wish to work on an open issue, please comment on the issue with `.take`, and it will be assigned to you.

If you contribute to the project for the first time, you can search for issues with `good first issue` or `bug` labels in the repository. Please only self-assign a `good first issue` one time.
:::info

If an issue is not assigned, it is assumed to be available for anyone to work on. Please assign yourself to an issue _before_ working on it to avoid conflicts.

:::

- Issues with the `needs triage` label are unavailable to `.take` until they are triaged and the label is removed. Feel free to check on the issue regularly if you want to work on it.
- If you contribute to the project for the first time, you can search for issues with `good first issue` or `bug` labels in the repository.

:::note

Please only self-assign a `good first issue` one time.

:::

In case you get stuck, feel free to ask for help in the [Discord](https://discord.gg/U2peSNf23P) server or [GitHub Discussions](https://github.com/orgs/open-sauced/discussions).

Please follow our [code of conduct](./code-of-conduct.md) in all your interactions with the project and its contributors.
Please follow our [Code of Conduct](./code-of-conduct.md) in all your interactions with the project and its contributors.

## Commits

Expand Down

0 comments on commit 785e75a

Please sign in to comment.