You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Pull Request Template
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->
Closes#5090
* READMEs badges and references
* Contributing docs
* Other doc references
* GitHub discussions
**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->
- Documentation update
**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->
sphinx-autobuild
mkdocs-serve
<img width="550" alt="Screenshot 2024-06-24 at 16 42 18"
src="https://github.com/argilla-io/argilla/assets/127759186/a6b36042-15ef-4c98-877b-2db7deaf5547">
**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->
- I made corresponding changes to the documentation
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ However you choose to contribute, please be mindful and respect our
13
13
14
14
## Need some help?
15
15
16
-
We understand that getting started might be scary and difficult, therefore, we provide a guided contributor mentorship program. Feel free to schedule a meeting [here](https://calendly.com/david-berenstein-huggingface/30min) to get you started. Alternatively, you can start with [joining our Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g) and reaching out in our [contributor channel](https://rubrixworkspace.slack.com/archives/C05BCGM277B).
16
+
We understand that getting started might be a bit difficult, therefore, you can join our discord channel [#argilla-general](https://discord.gg/hugging-face-879548962464493619) by selecting *Argilla* in *Channels and Roles* after joining the Discord.
@@ -61,7 +61,7 @@ We are an open-source community-driven project and we love to hear from you. Her
61
61
62
62
-[Community Meetup](https://lu.ma/embed-checkout/evt-IQtRiSuXZCIW6FB): listen in or present during one of our bi-weekly events.
63
63
64
-
-[Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g): get direct support from the community.
64
+
-[Discord](http://hf.co/join/discord): get direct support from the community in #argilla-general and #argilla-help.
65
65
66
66
-[Roadmap](https://github.com/orgs/argilla-io/projects/10/views/1): plans change but we love to discuss those with our community so feel encouraged to participate.
@@ -61,7 +61,7 @@ We are an open-source community-driven project and we love to hear from you. Her
61
61
62
62
-[Community Meetup](https://lu.ma/embed-checkout/evt-IQtRiSuXZCIW6FB): listen in or present during one of our bi-weekly events.
63
63
64
-
-[Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g): get direct support from the community.
64
+
-[Discord](http://hf.co/join/discord"): get direct support from the community in #argilla-general and #argilla-help.
65
65
66
66
-[Roadmap](https://github.com/orgs/argilla-io/projects/10/views/1): plans change but we love to discuss those with our community so feel encouraged to participate.
@@ -58,7 +58,7 @@ We are an open-source community-driven project and we love to hear from you. Her
58
58
59
59
-[Community Meetup](https://lu.ma/embed-checkout/evt-IQtRiSuXZCIW6FB): listen in or present during one of our bi-weekly events.
60
60
61
-
-[Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g): get direct support from the community.
61
+
-[Discord](http://hf.co/join/discord): get direct support from the community in #argilla-general and #argilla-help.
62
62
63
63
-[Roadmap](https://github.com/orgs/argilla-io/projects/10/views/1): plans change but we love to discuss those with our community so feel encouraged to participate.
Copy file name to clipboardExpand all lines: argilla/docs/community/contributor.md
+12-29Lines changed: 12 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,32 +9,22 @@ Thank you for investing your time in contributing to the project! Any contributi
9
9
??? Question "New to contributing in general?"
10
10
If you're a new contributor, read the [README](https://github.com/argilla-io/argilla/blob/develop/README.md) to get an overview of the project. In addition, here are some resources to help you get started with open-source contributions:
11
11
12
-
* **Slack**: You are welcome to join the [Argilla Slack community](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g), where you can keep in touch with other users, contributors and the Argilla team. In the following [section](#first-contact-in-slack), you can find more information on how to get started in Slack.
12
+
* **Discord**: You are welcome to join the [Argilla Discord community](http://hf.co/join/discord), where you can keep in touch with other users, contributors and the Argilla team. In the following [section](#first-contact-in-discord), you can find more information on how to get started in Discord.
13
13
* **Git**: This is a very useful tool to keep track of the changes in your files. Using the command-line interface (CLI), you can make your contributions easily. For that, you need to have it [installed and updated](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) on your computer.
14
14
* **GitHub**: It is a platform and cloud-based service that uses git and allows developers to collaborate on projects. To contribute to Argilla, you'll need to create an account. Check the [Contributor Workflow with Git and Github](#contributor-workflow-with-git-and-github) for more info.
15
15
* **Developer Documentation**: To collaborate, you'll need to set up an efficient environment. Check the [developer documentation](../getting_started/installation.md) to know how to do it.
16
16
* **Schedule a meeting with our developer advocate**: If you have more questions, do not hesitate to contact our developer advocate and [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min).
17
17
18
-
## First Contact in Slack
18
+
## First Contact in Discord
19
19
20
-
Slack is a very useful tool for more casual conversations and to answer day-to-day questions. Click [here](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g) to join our Slack community effortlessly.
20
+
Discord is a handy tool for more casual conversations and to answer day-to-day questions. As part of Hugging Face, we have set up some Argilla channels on the server. Click [here](http://hf.co/join/discord) to join the Hugging Face Discord community effortlessly.
21
21
22
-
The following screens will be displayed, choose how you wish to join and enter the code sent to you via email.
22
+
When part of the Hugging Face Discord, you can select "Channels & roles" and select "Argilla" along with any of the other groups that are interesting to you. "Argilla" will cover anything about argilla and distilabel. You can join the following channels:
***#argilla-general**: 📣 Stay up-to-date and general discussions.
25
+
***#argilla-help**: 🙋♀️ Need assistance? We're always here to help. Select the appropriate label (argilla or distilabel) for your issue and post it.
25
26
26
-
Once you have joined the community, you'll be added to some channels by default, but below we show you all the community channels you can join:
27
-
28
-
***00-announcements**: 📣 Stay up-to-date on official Argilla
29
-
***01-introductions**: 👋 Say hi! to the community Fun facts are appreciated.
30
-
***02-support-and-questions**: 🙋♀️ Need help with Argilla or NLP? We are always here.
31
-
***03-discoveries-and-news**: 📚 Looking for resources and news related to everything NLP?
32
-
***04-contributors**: 🏗️ A channel for contributions and contributors.
33
-
***05-beta-testing**: 🚧 For access to the latest features and help us with testing the newest features.
34
-
***06-general**: 🐒 This channel is for... well, everything else.
35
-
***07-distilabel**: ⚗️ For all of you questions about our Distilabel project.
36
-
37
-
So now there is only one thing left to do, introduce yourself and talk to the community. You'll be always welcome! 🤗👋
27
+
So now there is only one thing left to do: introduce yourself and talk to the community. You'll always be welcome! 🤗👋
38
28
39
29
40
30
## Contributor Workflow with Git and GitHub
@@ -113,6 +103,7 @@ git checkout [branch-name]
113
103
### Use CHANGELOG.md
114
104
115
105
If you are working on a new feature, it is a good practice to make note of it for others to keep up with the changes. For that, we utilize the `CHANGELOG.md` file in the root directory. This file is used to list changes made in each version of the project and there are headers that we use to denote each type of change.
106
+
116
107
-**Added:** for new features.
117
108
-**Changed:** for changes in existing functionality.
118
109
-**Deprecated:** for soon-to-be removed features.
@@ -171,19 +162,11 @@ First, click on `compare across forks` and select the right repositories and bra
Then, fill in the pull request template. In the title, add the feat, bug or docs prefix depending on the type of modification. A general template will be shown, please click on `Preview` and choose the corresponding pull request template. In addition, on the right side, you can select a reviewer (for instance, if you discussed the issue with a member of the Argilla team) and assign the pull request to yourself.
175
-
176
-
It is highly advisable to add labels to PR as well. You can do this again by the labels section right to the screen. For instance, if you are addressing a bug, add the `bug` label or if the PR is related to the documentation, add the `documentation` label. This way, PRs can be easily filtered.
177
-
178
-
Additionally, you should add a prefix to the PR name as we did with the branch above. If you are working on a new feature, you can name your PR as `feat: TITLE`. If your PR consists of a solution for a bug, you can name your PR as `bug: TITLE` And, if your work is for improving the documentation, you can name your PR as `docs: TITLE`.
Then, fill in the pull request template. You should add a prefix to the PR name as we did with the branch above. If you are working on a new feature, you can name your PR as `feat: TITLE`. If your PR consists of a solution for a bug, you can name your PR as `bug: TITLE` And, if your work is for improving the documentation, you can name your PR as `docs: TITLE`.
183
166
184
-
Below, we chose the feature template. Now, fill in it carefully and follow the guidelines. Remember to link the original issue. Finally, enable the checkbox to allow maintainer edits so the branch can be updated for a merge and click on `Create pull request`.
167
+
In addition, on the right side, you can select a reviewer (for instance, if you discussed the issue with a member of the Argilla team) and assign the pull request to yourself. It is highly advisable to add labels to PR as well. You can do this again by the labels section right to the screen. For instance, if you are addressing a bug, add the `bug` label or if the PR is related to the documentation, add the `documentation` label. This way, PRs can be easily filtered.
Finally, fill in the template carefully and follow the guidelines. Remember to link the original issue and enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Then, click on `Create pullrequest`.
187
170
188
171
189
172
### Review your pull request
@@ -209,7 +192,7 @@ Additionally, we will include your changes in the next release based on our [dev
209
192
210
193
Here are some helpful resources for your reference.
211
194
212
-
*[Configuring Slack](https://slack.com/help/articles/218080037-Getting-started-for-new-Slack-users), a guide to learn how to configure Slack.
195
+
*[Configuring Discord](https://support.discord.com/hc/en-us/categories/115000217151), a guide to learn how to get started with Discord.
213
196
*[Pro Git](https://git-scm.com/book/en/v2), a book to learn Git.
214
197
*[Git in VSCode](https://code.visualstudio.com/docs/sourcecontrol/overview), a guide to learn how to easily use Git in VSCode.
215
198
*[GitHub Skills](https://skills.github.com/), an interactive course to learn GitHub.
0 commit comments