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

Update README.md #411

Merged
merged 2 commits into from
Aug 22, 2023
Merged

Update README.md #411

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9638da2
Update README.md
amunjuluri Aug 21, 2023
5d8b163
Update README.md
amunjuluri Aug 22, 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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,23 @@ The generated index can be searched from <https://clotributor.dev>. The followin
- Use multiple words to refine the search. **Example:** [*gitops go*](https://clotributor.dev/search?ts_query_web=gitops+go)
- Use `-` to exclude words from the search. **Example:** [*rust -webassembly*](https://clotributor.dev/search?ts_query_web=rust+-webassembly)
- Put a phrase inside `double quotes` for an exact match. **Example:** [*"machine learning"*](https://clotributor.dev/search?ts_query_web=%22machine+learning%22)
- Use `or` to combine multiple searches. **Example:** [*networking or security*](https://clotributor.dev/search?ts_query_web=networking+or+security)
- Use `or` combine multiple searches. **Example:** [*networking or security*](https://clotributor.dev/search?ts_query_web=networking+or+security)

It's possible to search by project name, repository name, description, topics or programming languages, as well as issue title and labels. Prefix matching for all of them is also supported (e.g. searching for `backst` should return issues from the `Backstage` project).
It's possible to search by project name, repository name, description, topics, or programming languages, as well as issue title and labels. Prefix matching for all of them is also supported (e.g. searching for `backst` should return issues from the `Backstage` project).

## Labels with special meaning

Some of the features of **CLOTributor** are controlled by some special labels (or labels that contain some strings) that can be set on issues. One of the most important labels for CLOTributor is `help wanted`, as it only processes issues where help is wanted. Issues are categorized in some different ways based on these labels:

#### Area

- **docs**: the issue has a label thay contains the string `docs` or `documentation`.
- **docs**: the issue has a label that contains the string `docs` or `documentation`.

#### Kind

- **bug**: the issue has a label thay contains the string `bug`.
- **feature**: the issue has a label thay contains the string `feature`.
- **enhancement**: the issue has a label thay contains the string `enhancement` or `improvement`.
- **bug**: the issue has a label that contains the string `bug`.
- **feature**: the issue has a label that contains the string `feature`.
- **enhancement**: the issue has a label that contains the string `enhancement` or `improvement`.

#### Difficulty

Expand Down