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

refactor: improve get pop issues #5135

Merged
merged 3 commits into from
Jul 3, 2024
Merged

Conversation

sdiazlor
Copy link
Contributor

@sdiazlor sdiazlor commented Jun 30, 2024

Pull Request Template

Closes #5116

CONSIDERATIONS:

  • I fixed the planned issues, BUT to order them in descending order, I had to filter by v2. and the open ones (there were old milestones, and if the closed ones are shown, only those will be shown). FOR DISTILABEL UPDATE, the v2 filter should be removed.
    I removed an API call as I found a key to determine if a member of the org/repo opened the issue (pre-commit should not be additionally added as previously because it only creates PRs, not issues). Locally, with a token with the permissions defined, it correctly removed the members.
  • I realized that the API call to list the issues also retrieves the pull requests, so I added an if statement to filter them.
  • I removed unneeded keys.
Screenshot 2024-06-30 at 02 42 51 Screenshot 2024-06-30 at 02 42 38 Screenshot 2024-06-30 at 02 42 44

Type of change

  • Refactor (change restructuring the codebase without changing functionality)
  • Improvement (change adding some improvement to an existing functionality)
  • Documentation update

How Has This Been Tested

Checklist

  • I made corresponding changes to the documentation
  • I confirm My changes generate no new warnings

@nataliaElv
Copy link
Member

Thanks @sdiazlor ! Everything looks good. I just don't understand very well why planned issues need to be filtered by "v2". I think this might make the code difficult to maintain in the future, although it might work for now.

If we cannot find a good solution to this, maybe we can eliminate this section. Here is my thinking:

  1. milestones can be easily checked in github, so this section is redundant. -> possible solution, add somewhere a link to our github milestones.
  2. I'm not sure how useful it is for the community to see all the internal tasks that we have planned for each milestone. It's probably more interesting to see if the popular issues / community issues have been selected for a specific release -> possible solution, add to these two tables a "Milestone"/"Expected version" column.

What do you think @sdiazlor @davidberenstein1957 ?

@davidberenstein1957
Copy link
Member

@nataliaElv I think we can keep it assuming the next sentence is correct. We filter on startswith v2 to avoid potential other issues showing up so this wouldn't require any updates until v3, correct @sdiazlor? I agree we can find issues and milestones on GH but not everyone is as familiar with using open-source GH so it might be a good indirect funnel to guide people there.

Copy link
Member

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the discussion I would personally accept.

@sdiazlor
Copy link
Contributor Author

sdiazlor commented Jul 3, 2024

@nataliaElv @davidberenstein1957 Yes, "v2" doesn't need to be updated until "v3". The reason to filter it is that, in descending order, the first milestones are shown, so it would show the 1.x first (some are still open).

@nataliaElv
Copy link
Member

I'm just saying that we should find a solution for future versions for these reasons:

  1. Sometimes we forget to add v in front of milestone names 😅 We can try to be careful with that, but human error happens.
  2. By the time we get to Argilla 3.x, will we even remember that we added a starts with v2 filter in some hidden line of the docs code?
  3. Do users who check our documentation really want to see all the small technical tasks that we assign to those milestones? I don't think so. Specially those that @davidberenstein1957 mentions not being familiar with GH.
    Perhaps the v1 issues that are open should be either closed or have the milestone removed 😅 I'll check those to clean them up anyway.

@nataliaElv
Copy link
Member

Anyway, we can merge this change and find a solution later on 🙂

@sdiazlor
Copy link
Contributor Author

sdiazlor commented Jul 3, 2024

@nataliaElv Then, maybe you're referring more to the roadmap? But then they can go to that page, that's why I believe they are different things. Or, in any case, instead of the planned issues in detail, add the roadmap issues ¿?

sdiazlor and others added 2 commits July 3, 2024 12:08
Co-authored-by: David Berenstein <david.m.berenstein@gmail.com>
@sdiazlor sdiazlor merged commit d9b215d into main Jul 3, 2024
17 checks passed
@sdiazlor sdiazlor deleted the docs/review-issue-dashboard branch July 3, 2024 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants