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

Sync file paths, metadata, and documentation with the problem-specifications repository #2869

Merged

Conversation

jagdish-15
Copy link
Contributor

@jagdish-15 jagdish-15 commented Nov 19, 2024

Pull Request

This PR aims to synchronize all previously unsynced tests, file paths, metadata, and documentation with the problem-specifications repository.

Proof of Sync

Screenshot 2024-11-19 102834

Reviewer Resources:

Track Policies

@jagdish-15
Copy link
Contributor Author

As discussed in the previous PR, I am planning to close that PR and have raised this one to focus on updating documentation, file paths, and metadata—essentially, all changes that do not require manual updates like tests.

For the test updates, I will raise seven separate PRs, one for each exercise, to ensure clarity and ease of review.

Copy link
Member

@kahgoh kahgoh left a comment

Choose a reason for hiding this comment

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

Thanks @jagdish-15! I've just had a quick glance at the changes.

@@ -16,6 +16,9 @@
"editor": [
"src/main/java/Node.java",
"src/main/java/Edge.java"
],
"invalidator": [
"build.gradle"
Copy link
Member

Choose a reason for hiding this comment

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

Did you mean to commit this change? It isn't clear to me why we would want to add this to the invalidator.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was part of the metadata sync performed by configlet with the Problem Specifications repository.

Copy link
Member

Choose a reason for hiding this comment

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

Ah, that makes sense! Thanks for letting me know.

@jagdish-15
Copy link
Contributor Author

jagdish-15 commented Nov 20, 2024

Hi @kahgoh,

This commit syncs the metadata of the Pythagorean Triplet exercise and the instructions.md for the Complex Number exercise, which I recently updated. The PR for the updated instructions.md file has been accepted in the problem-specifications repo.

Screenshot 2024-11-20 132640

I wanted to check if contributors typically add their names to the list of authors or contributors when updating an exercise's instructions.md. If not, that’s completely fine—I just want to ensure I’m following the usual practices.

Thanks!

@kahgoh
Copy link
Member

kahgoh commented Nov 20, 2024

I wanted to check if contributors typically add their names to the list of authors or contributors when updating an exercise's instructions.md. If not, that’s completely fine—I just want to ensure I’m following the usual practices.

I think we normally don't add to the contributors for syncing the instructions.md.

@kahgoh kahgoh added the x:size/small Small amount of work label Nov 20, 2024
@kahgoh kahgoh merged commit bf8a4c3 into exercism:main Nov 20, 2024
2 checks passed
@jagdish-15
Copy link
Contributor Author

I think we normally don't add to the contributors for syncing the instructions.md.

Hello @kahgoh, I believe there’s been a misunderstanding. I wasn’t referring to syncing the instructions.md. What I meant is that I authored the current introduction.md for the Complex Numbers exercise. My PR was recently accepted in the Problem Specifications repository. So, I wasn’t asking about the syncing process—I’m clarifying that I actually wrote the introduction.md in the Problem Specifications repo. I hope this clears up the confusion.

@kahgoh
Copy link
Member

kahgoh commented Nov 20, 2024

Hi @jagdish-15, looking at the past precedence (like, for example, in PR #2644, when the leap docs where re-synced after a rewrite) we still normally don't add to the contributors. Adding the contributor (for changes to the Problem Specification) would require the tracks to be aware of the changes to know when to add to the contributor for the exercise across the tracks, which isn't always easy.

@jagdish-15
Copy link
Contributor Author

jagdish-15 commented Nov 20, 2024

Hi @kahgoh,

Thank you for explaining the precedent regarding contributors. I appreciate the insight and completely understand that it might not always be practical to track and add contributors across different tracks for updates originating from the Problem Specifications repository.

I realize I might have been a bit eager in this case, and I truly appreciate your patience in clarifying the usual practices. Moving forward, I'll ensure to align with these norms. Thanks again for your guidance, and I’m glad to have had the opportunity to contribute to the track in any way I can!

@jagdish-15 jagdish-15 deleted the sync-documents-with-problem-specification branch November 26, 2024 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:size/small Small amount of work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants