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

Docs: Update "Issues" section in the "Introduction to Contributing" chapter #249

Closed
2 tasks
adiati98 opened this issue Feb 10, 2024 · 7 comments · Fixed by #269
Closed
2 tasks

Docs: Update "Issues" section in the "Introduction to Contributing" chapter #249

adiati98 opened this issue Feb 10, 2024 · 7 comments · Fixed by #269

Comments

@adiati98
Copy link
Member

adiati98 commented Feb 10, 2024

Description

Issues with "needs triage" label are not available to take until the label is removed. Our bot gives this information whenever someone use the .take command. However, this information is also worth to mention in the docs.

Suggested Solution

  • Add information about it, change the format in this section to undordered list, and adjust some wording for better read and understanding.

Here is the copy:

## Issues

- If you wish to work on an open issue, please comment on the issue with `.take`, and it will be assigned to you.

  :::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.

  :::
  • Capitalize the "code of conduct" term in the last paragraph.

    - 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.

Code Blocks

Below are the code blocks that need to be changed:

## 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 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.
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.

Note

  • Please check each list whenever you fixed an item.
  • Please move the checklists in your PR and check them when they are complete.
@HappyLife2
Copy link

.take

Copy link
Contributor

Thanks for taking this on! If you have not already, join the conversation in our Discord

@adiati98
Copy link
Member Author

Hey @HappyLife2,

Checking in here.
How is this going? Do you need any help?
I've updated the instructions in the issue to (hopefully) make it easier for you to understand.

Also, heads up. If there is no activity for this issue until the end of this week (Friday), we will unassign you and give this issue to other contributor to work on. 😊

Thank you!

@adiati98
Copy link
Member Author

adiati98 commented Mar 2, 2024

Hi @HappyLife2,

Because there is no response from you on this issue, as per informed on the last comment we unassign you from this issue.

Feel free to take it if you're still interested and when there is no one assigned to this issue.

Thank you. 😊

@smhussain5
Copy link
Contributor

.take

(Will work on it today and let you know if there are any questions!)

Copy link
Contributor

github-actions bot commented Mar 2, 2024

Thanks for taking this on! If you have not already, join the conversation in our Discord

This was referenced Mar 3, 2024
Copy link
Contributor

github-actions bot commented Mar 4, 2024

🎉 This issue has been resolved in version 1.66.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment