Contributor Documentation #

Thank you for investing your time in contributing to the project! Any contribution you make will be reflected in the most recent version of Argilla 🤩.

Read the Code of Conduct to keep the community approachable and respectable.

In this guide, you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide#

To get an overview of the project, read the README. Here are some resources to help you get started with open-source contributions:

Getting started#

To navigate the codebase with confidence, see our Python client code 🐍. For more information on how to use our UI, see our web app reference 💻.

We accept three kinds of contributions.

  • documentation: better explanations, writing style, and help using Argilla’s features. Best to get started.

  • issues: bug reports and fixes of something that is broken. Generally smaller in nature.

  • features: new functionalities and enhancements of existing features. Generally larger in nature.

Issues#

Create a new issue#

If you spot a problem with the docs or our code, search if an issue already exists. If a related issue doesn’t exist, you can open a new issue using a relevant issue form. Try to fill out the entire template to ensure it is clear what the issue entails and it is reproducible for other users.

Solve an issue#

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to create a fork and start making changes. However, we always advise you to ask for some input within the discussion on the issue, or by contacting us via Slack or by scheduling a meeting.

Features and documentation#

Contribution to the docs#

You can contribute to the docs by

  • Writing a tutorial about a specific topic. We are always looking for new tutorials and we would love to support you!

  • Including missing parts, examples, improving the writing, fixing typos, etc.

For contributing to the docs, here are two references:

  1. How to locally build the docs

  2. A template for tutorials

Create a new feature#

If you feel something can be enhanced, search if the feature already exists. If a related feature doesn’t exist, you can open a new feature using a relevant feature form. Try to fill out the entire template to ensure it is clear what the issue entails and it is reproducible for other users. For documentation, assign the label documentation too.

Solve an existing feature#

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find a feature to work on, you are welcome to create a fork and start making changes. However, we always advise you to ask for some input within the discussion on the issue, or by contacting us via Slack or by scheduling a meeting.

Make Changes#

  • Create a fork of our development branch.

    • Note, for updates solely to the documentation, you are allowed to work in the main branch.

  • To start working on code changes, we suggest, you take a look at our tutorial on setting up the development environment.

  • Work on your awesome contribution and adhere to our formatting guidelines.

    • Don´t forget to also check if:

      • Your update requires updates to our docs.

      • Your update and fork are mentioned in the original issue or feature.

  • Finally, open a PR with a fix.

Pull Request#

When you’re finished with the changes, create a pull request, also known as a PR.

  • Open a PR in the Argilla repo.

  • Fill the PR template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.

  • Don’t forget to link PR to issue within the template next to the “Closes #” in the template.

  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.

  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.

  • As you update your PR and apply changes, mark each conversation as resolved.

  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!#

Congratulations 🎉🎊 We thank you 🫡

Once your PR is merged, your contributions will be publicly visible on the Argilla GitHub.

Additionally, we will include your changes in the next release based on our development branch.

We will probably contact you, but if you would like to send your personal information (LinkedIn, profile picture, GitHub) to david, he can set everything up for receiving your JustDiggit bunds and a LinkedIn shoutout.